-
Notifications
You must be signed in to change notification settings - Fork 7
fix(#298): add go install instructions to bundled notion-cli plugin #375
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,11 +58,26 @@ export NOTION_TOKEN=ntn_xxxxx | |
|
|
||
| ## Installation | ||
|
|
||
| The recommended install is with `go install`. The resulting binary is named `notion-cli`, so symlink or rename it to `notion` before running any commands: | ||
|
|
||
| ```bash | ||
| go install github.com/4ier/notion-cli@latest | ||
| GOBIN=$(go env GOBIN); GOPATH=$(go env GOPATH); ln -sf "${GOBIN:-$GOPATH/bin}/notion-cli" "${GOBIN:-$GOPATH/bin}/notion" | ||
| ``` | ||
|
|
||
| Or install with Homebrew: | ||
|
|
||
| ```bash | ||
| brew install 4ier/tap/notion-cli | ||
| ``` | ||
|
|
||
| Or download binary from [GitHub Releases](https://github.com/4ier/notion-cli/releases). | ||
| Or install with npm: | ||
|
|
||
| ```bash | ||
| npm install -g @4ier/notion-cli | ||
| ``` | ||
|
|
||
| Or download a binary from [GitHub Releases](https://github.com/4ier/notion-cli/releases). | ||
|
Comment on lines
+68
to
+80
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Document the Scoop installation option. The PR objectives and 🤖 Prompt for AI Agents |
||
|
|
||
| ## Key Features | ||
| - **Agent-friendly**: JSON output auto-detected when piped, schema-aware, URL or ID support | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: javimosch/supercli
Length of output: 400
🏁 Script executed:
Repository: javimosch/supercli
Length of output: 14511
🌐 Web query:
Go install command GOBIN default path $GOPATH/bin documentation💡 Result:
The go install command installs executable binaries into the directory specified by the GOBIN environment variable [1][2]. If GOBIN is not explicitly set, it defaults to the bin subdirectory of the primary GOPATH [1][2]. If GOPATH itself is not set, the default GOPATH is $HOME/go on Unix systems (such as Linux and macOS) and %USERPROFILE%\go on Windows [2][3]. Consequently, when neither GOBIN nor GOPATH is explicitly configured, the default installation path is $HOME/go/bin or %USERPROFILE%\go\bin, respectively [1][2]. You can verify the current effective location for your environment by running the command go env GOBIN or go env GOPATH [2][4]. To change the installation directory, you can set the GOBIN environment variable using the command go env -w GOBIN=/your/custom/path [2][4].
Citations:
🌐 Web query:
SuperCLI plugin binary check which command binary check mechanism💡 Result:
The binary check mechanism for SuperCLI plugins depends on the specific project implementation, as multiple tools use this name. For the javimosch/supercli ecosystem, plugin binary requirements are handled via manifest files and diagnostics [1][2]: 1. Manifest-Driven Configuration: Plugins bundle a
plugin.jsonmanifest that includes metadata and dependency requirements [2][3]. Developers can define specific binary and environment variable checks within this configuration to ensure that required external dependencies are present on the host system [1]. 2. Diagnostic Checks: When a command is executed, SuperCLI provides diagnostic mechanisms to assist users when dependencies or binaries are missing [1][2]. If a required binary (such as a Zig-based plugin component) is not found, the system often provides feedback and may suggest alternatives, such as using a Node.js fallback runtime that shares the same plugin state [2][3]. 3. Sync and Validation: During server-client synchronization (supercli sync), the system validates plugin payloads via checksums and signature checks to ensure integrity [4]. For the snakex21/SuperCli implementation (a Go-based AI coding agent), the binary check mechanism is integrated into the core diagnostic system [5]: 1. Doctor Command: The--doctorflag (or/doctorin the TUI) executes a suite of diagnostics that explicitly verify binary paths, environment configurations, and the availability of essential tools (such as git or ripgrep) [5]. 2. Runtime Startup Checks: The binary performs automatic startup checks to ensure that required directories (like the data directory) are writable, providing clear error instructions if the environment is incorrectly configured [5]. Because SuperCLI is a name shared by different projects, you should verify which implementation you are using by checking the repository or documentation provided in your specific environment [2][5].Citations:
Make the Go-installed
notionbinary discoverable throughPATH.The Go install path is not always on
PATH, butplugin.jsonchecks and commands rely onnotion. If the symlink is placed under${GOBIN:-$GOPATH/bin}, setPATHor install into an existingPATHdirectory. Apply this toplugins/notion-cli/install-guidance.json,plugins/notion-cli/plugin.json, andplugins/notion-cli/skills/quickstart/SKILL.md.📍 Affects 3 files
plugins/notion-cli/install-guidance.json#L7-L8(this comment)plugins/notion-cli/plugin.json#L14-L15plugins/notion-cli/plugin.json#L34-L34plugins/notion-cli/plugin.json#L234-L234plugins/notion-cli/skills/quickstart/SKILL.md#L61-L66🤖 Prompt for AI Agents