fix(#298): add go install instructions to notion-cli plugin - #367
fix(#298): add go install instructions to notion-cli plugin#367javimosch wants to merge 1 commit into
Conversation
Adds the official `go install github.com/4ier/notion-cli@latest` installation method to the notion-cli plugin manifest, install guidance, and quickstart skill. Homebrew and GitHub releases remain as alternatives. Fixes #298 Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
📝 WalkthroughWalkthroughThe Notion CLI documentation and plugin messages now recommend Go installation, retain Homebrew as an alternative, and document GitHub Releases, npm, token storage, and piped JSON behavior. ChangesNotion CLI installation guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@plugins/notion-cli/install-guidance.json`:
- Around line 8-9: Update the authentication guidance strings to avoid embedding
the token directly in command text or shell history: use a hidden prompt or
external secret source and pipe its value into `notion auth login --with-token`.
Revise or remove the `NOTION_TOKEN` alternative so it likewise does not expose
the real token in shell history.
- Line 12: Update the note string in install-guidance.json to scope the mode
0600 file-permission guarantee explicitly to Unix-like systems, and add separate
wording describing the Windows read-only file-attribute protection. Keep the
existing installation sources and token path unchanged.
- Around line 6-7: Document the Go binary PATH requirement before verification
or authentication: in plugins/notion-cli/install-guidance.json lines 6-7,
plugins/notion-cli/skills/quickstart/SKILL.md lines 61-63, and
plugins/notion-cli/plugin.json line 14, add a PATH setup step or explicit
GOBIN/GOPATH/bin install-location guidance so the installed notion binary is
discoverable by notion --version and plugin checks.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 39f8ba7d-7039-4642-b850-c86edcb6e3ea
📒 Files selected for processing (3)
plugins/notion-cli/install-guidance.jsonplugins/notion-cli/plugin.jsonplugins/notion-cli/skills/quickstart/SKILL.md
| "go install github.com/4ier/notion-cli@latest", | ||
| "Verify: notion --version", |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/usr/bin/env sh
set -eu
gobin="$(go env GOBIN)"
if [ -z "$gobin" ]; then
gobin="$(go env GOPATH)/bin"
fi
test -x "$gobin/notion"
case ":${PATH:-}:" in
*":$gobin:"*) ;;
*) echo "$gobin is not in PATH" >&2; exit 1 ;;
esac
command -v notion >/dev/nullRepository: javimosch/supercli
Length of output: 156
🏁 Script executed:
#!/usr/bin/env sh
set -eu
echo "Go environment:"
gop="$(go env GOPATH)"
gob=$(go env GOBIN)
if [ -z "$gob" ]; then
gob="$gop/bin"
fi
printf "GOPATH=%s\nGOBIN=%s\nDEFAULT_BIN=%s\nPATH=%s\n" "$gop" "$(go env GOBIN)" "$gob" "$PATH"
printf "default binary exists executable? "
[ -x "$gob/notion" ] && echo yes || echo no
printf "default binary in PATH? "
case ":${PATH:-}:" in
*":$gob:") echo yes ;;
*) echo no ;;
esac
printf "notion available? "
command -v notion >/dev/null && echo yes || echo no
echo
echo "Relevant files:"
for f in plugins/notion-cli/install-guidance.json plugins/notion-cli/plugin.json plugins/notion-cli/skills/quickstart/SKILL.md; do
if [ -f "$f" ]; then
echo "--- $f ---"
sed -n '1,90p' "$f"
fi
doneRepository: javimosch/supercli
Length of output: 6974
🌐 Web query:
go install executable GOPATH/bin GOBIN PATH official documentation
💡 Result:
When you run the go install command, the Go toolchain compiles and installs executables based on the following precedence for the installation directory [1][2][3]: 1. GOBIN Environment Variable: If the GOBIN environment variable is set, Go installs executables directly into this directory [1][2][4]. 2. Default Location: If GOBIN is not set, Go installs executables into the bin subdirectory of the GOPATH [1][2][4]. If GOPATH is not set, it defaults to $HOME/go/bin (on Unix) or %USERPROFILE%\go\bin (on Windows) [1][2][4]. Note that executables in the Go installation root (GOROOT) are installed into $GOROOT/bin or the GOTOOLDIR, rather than the GOBIN path [1][5]. To discover exactly where your Go binaries are currently being installed, you can use the following command [6]: go list -f '{{.Target}}' If you wish to change this location, you can set the GOBIN variable using the go env command [6][2]: go env -w GOBIN=/path/to/your/bin To run these installed executables without providing a full path, the directory containing them must be included in your system's PATH environment variable [6][2]. You can verify the current bin directory location by running go env GOBIN or by checking your GOPATH configuration [2][4][7].
Citations:
- 1: https://pkg.go.dev/cmd/go
- 2: https://go.dev/doc/code
- 3: https://pkg.go.dev/cmd/go@go1.26.4
- 4: https://go.dev/wiki/GOPATH
- 5: https://manpages.debian.org/unstable/golang-go/go-install.1.en.html
- 6: https://go.dev/doc/tutorial/compile-install
- 7: https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/go/gobin.html
Document the Go binary PATH requirement.
go install puts executables in GOBIN or GOPATH/bin; notion --version and the plugin check require the installed binary to be in PATH. Add a PATH setup step or explicit install-location guidance before the verification/auth commands.
Applies to plugins/notion-cli/install-guidance.json, plugins/notion-cli/plugin.json, and plugins/notion-cli/skills/quickstart/SKILL.md.
📍 Affects 3 files
plugins/notion-cli/install-guidance.json#L6-L7(this comment)plugins/notion-cli/skills/quickstart/SKILL.md#L61-L63plugins/notion-cli/plugin.json#L14-L14
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plugins/notion-cli/install-guidance.json` around lines 6 - 7, Document the Go
binary PATH requirement before verification or authentication: in
plugins/notion-cli/install-guidance.json lines 6-7,
plugins/notion-cli/skills/quickstart/SKILL.md lines 61-63, and
plugins/notion-cli/plugin.json line 14, add a PATH setup step or explicit
GOBIN/GOPATH/bin install-location guidance so the installed notion binary is
discoverable by notion --version and plugin checks.
| "Authenticate: echo 'ntn_xxxxx' | notion auth login --with-token", | ||
| "Alternative auth: export NOTION_TOKEN=ntn_xxxxx", |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Do not place the real token in shell history.
When users replace ntn_xxxxx, both commands can record the token in shell history. Use a hidden prompt or an external secret source, then pipe the value to notion auth login --with-token.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plugins/notion-cli/install-guidance.json` around lines 8 - 9, Update the
authentication guidance strings to avoid embedding the token directly in command
text or shell history: use a hidden prompt or external secret source and pipe
its value into `notion auth login --with-token`. Revise or remove the
`NOTION_TOKEN` alternative so it likewise does not expose the real token in
shell history.
| "supercli plugins install ./plugins/notion-cli --on-conflict replace --json" | ||
| ], | ||
| "note": "Also available as Go binary from GitHub Releases: https://github.com/4ier/notion-cli/releases. npm: npm install -g @4ier/notion-cli. Token stored in ~/.config/notion-cli/config.json (mode 0600). Auto-detects JSON output when piped to another command." | ||
| "note": "Also available via Homebrew (brew install 4ier/tap/notion-cli), as a Go binary from GitHub Releases (https://github.com/4ier/notion-cli/releases), or via npm (npm install -g @4ier/notion-cli). Token stored in ~/.config/notion-cli/config.json (mode 0600). Auto-detects JSON output when piped to another command." |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== file =="
cat -n plugins/notion-cli/install-guidance.json
echo
echo "== notion-cli plugin files =="
git ls-files plugins/notion-cli | sort
echo
echo "== related os.Chmod usages in notion-cli =="
rg -n "0600|os\\.Chmod|config\\.json|notion-cli/config" plugins/notion-cli -S || trueRepository: javimosch/supercli
Length of output: 1567
🌐 Web query:
Go os.Chmod Windows Unix mode bits ignore permissions official documentation
💡 Result:
In Go, the os.Chmod and (*File).Chmod functions behave differently on Windows compared to Unix-based systems because Windows does not support standard Unix-style permission bits [1][2]. Official documentation specifies that on Windows, os.Chmod only utilizes the 0o200 bit (the owner writable bit) of the provided mode [1][3]. This specific bit controls whether the file's read-only attribute is set or cleared [1][2]. All other permission bits (such as group or world permissions, or special bits like setuid/setgid) are ignored [1][2]. When using os.Chmod on Windows: - Setting the 0o200 bit (e.g., in 0o600) clears the read-only attribute, making the file writable [1][2]. - Omitting the 0o200 bit (e.g., in 0o400) sets the read-only attribute [1][2]. Important implementation notes: - The behavior is limited to files; Windows does not respect the read-only file attribute on directories in the same way [4][5]. - For backward compatibility with Go 1.12 and earlier, it is recommended to provide a non-zero mode [1][2]. - Historically, (*File).Chmod was not fully supported on Windows, leading to errors in older versions of Go [6][7], but it has since been implemented to align with the behavior of os.Chmod [6]. Always refer to the current documentation for your specific Go version, as subtle differences or error handling may have evolved [3][7].
Citations:
- 1: https://pkg.go.dev/os?GOOS=windows
- 2: https://go.googlesource.com/go/+/refs/heads/master/src/os/file.go
- 3: https://pkg.go.dev/os@go1.26.4
- 4: syscall: windows doesn't allow read-only directories golang/go#35042
- 5: golang/go@16f0f9c
- 6: os.Chmod file.Chmod different behavior on Windows golang/go#39606
- 7: https://pkg.go.dev/os?utm_source=godoc
Limit the 0600 protection note to Unix-like systems.
The mode 0600 guarantee does not carry across to Windows in the same way; on Windows, Unix-style chmod bits are handled by the read-only file attribute, not owner-only ACLs. State that 0600 applies on Unix-like systems and document the Windows-only protection separately.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plugins/notion-cli/install-guidance.json` at line 12, Update the note string
in install-guidance.json to scope the mode 0600 file-permission guarantee
explicitly to Unix-like systems, and add separate wording describing the Windows
read-only file-attribute protection. Keep the existing installation sources and
token path unchanged.
1 participant
Automated maintenance run by automaintainer.
Focus: ISSUE FIX OBJECTIVE (GitHub Issue #298: "Add 4ier/notion-cli as bundled plugin")
ISSUE DESCRIPTION:
Feature Request: Add Notion CLI Plugin
Plugin: 4ier/notion-cli
Why this plugin?
Key Features
Installation
Use Cases
Comparison
Provides more comprehensive API coverage than alternatives like the official
ntnCLI, with better cross-platform support (including Windows).Generated with Devin
APPROACH: Minimal fix — implement the described change with the smallest safe diff. Stay as close to the issue description as possible.
PROCEDURE (follow in order, do not deviate):
Branch:
am/am-f17c27-dkf5c0j0zay2-eb4e39b6Diff:
Summary by CodeRabbit