Command-line client for the n8n public API.
macOS and Linux, into ~/.local/bin:
curl -fsSL https://raw.githubusercontent.com/SomeoneWithOptions/n8n-cli/main/install.sh | shWindows (PowerShell), into %LOCALAPPDATA%\n8n-cli\bin:
irm https://raw.githubusercontent.com/SomeoneWithOptions/n8n-cli/main/install.ps1 | iexIf PowerShell blocks the pipe, bypass the policy for that one command:
powershell -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/SomeoneWithOptions/n8n-cli/main/install.ps1 | iex"Both scripts install the binary and nothing else. Neither creates or edits
contexts or credentials; n8n auth login owns that state. The Unix script warns
when the install directory is not on PATH; the Windows script appends it to
the user PATH and never touches the machine PATH.
Environment overrides, same names on both platforms:
| Variable | Effect |
|---|---|
N8N_CLI_VERSION |
Install this tag instead of the latest release |
N8N_CLI_INSTALL_DIR |
Install into this directory instead of the default |
With a Go toolchain:
go install github.com/SomeoneWithOptions/n8n-cli/cmd/n8n@latestOr download a binary directly from the
releases page. Assets
are plain binaries named n8n-<os>-<arch> (n8n-windows-amd64.exe on Windows)
for linux/amd64, linux/arm64, darwin/amd64, darwin/arm64 and
windows/amd64, alongside checksums.txt:
curl -fsSLO https://github.com/SomeoneWithOptions/n8n-cli/releases/latest/download/n8n-linux-amd64
curl -fsSLO https://github.com/SomeoneWithOptions/n8n-cli/releases/latest/download/checksums.txt
sha256sum --check --ignore-missing checksums.txt
chmod +x n8n-linux-amd64 && mv n8n-linux-amd64 ~/.local/bin/n8nVerify the install with n8n version, which reports the release tag, commit and
build date.
n8n update --check # report the installed and latest versions, write nothing
n8n update # download, verify and replace this binary, after askingn8n update installs the release asset for the current platform, checks it
against the release checksums.txt, and runs it once to confirm it reports the
expected version before replacing the binary in place. Contexts and credentials
are untouched. A development build, or a binary owned by Homebrew, Nix, Snap,
go install or a system package, is refused unless --force is passed: update
those where they were installed from. n8n update --version vX.Y.Z installs an
exact tag. See docs/n8n_update.md.
n8n completion bash > /etc/bash_completion.d/n8n # bash
n8n completion zsh > "${fpath[1]}/_n8n" # zsh
n8n completion fish > ~/.config/fish/completions/n8n.fish
n8n completion powershell | Out-String | Invoke-Expressionn8n completion --help documents per-shell placement and reloading.
n8n auth login --url https://n8n.example.com
n8n auth status --check
n8n discoverdocs/README.md is generated from the command help.
Regenerate it with make docs after changing any command's help text.
- n8n API — 1:1 coverage of the n8n public API.
- CLI-only extensions — CLI setup and beyond-spec helpers, maintained here.
Contribute via fork + PR, or open issue. See CONTRIBUTING.md. Report vulnerabilities privately per SECURITY.md.
MIT. See LICENSE.