Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/groniz/groniz-cli/llms.txt

Use this file to discover all available pages before exploring further.

There are two things you may want to install: the Groniz CLI binary, which is the tool you run in your terminal or scripts, and the groniz/groniz-cli agent skill, which teaches AI coding agents how to drive the CLI correctly. Most developers install both. The CLI is required; the skill is only needed if you plan to let an agent (Claude Code, Cursor, etc.) call Groniz commands on your behalf.

CLI Installation

One-line install

curl -fsSL https://groniz.com/install.sh | sh
The installer performs the following steps automatically:
  1. Detects your operating system and CPU architecture.
  2. Downloads the appropriate pre-built native binary.
  3. Verifies the download against its SHA-256 checksum.
  4. Installs the binary to ~/.groniz/bin/groniz.
  5. Adds ~/.groniz/bin to your shell PATH (writes to your shell profile if needed).
The Groniz CLI is a self-contained native binary. It does not require Node.js, npm, Python, or any other runtime. The only prerequisite is curl — which is pre-installed on all supported platforms.

Supported platforms

OSArchitecture
Linuxx64 (glibc)
Linuxarm64 (glibc)
macOSx64 (Intel)
macOSarm64 (Apple Silicon)

Verify the installation

After the installer completes, open a new terminal (or source your profile) and run:
groniz --help
You should see the top-level help text listing every available command. If the command is not found, add ~/.groniz/bin to your PATH manually:
export PATH="$HOME/.groniz/bin:$PATH"
Add that line to your ~/.bashrc, ~/.zshrc, or equivalent shell profile to make it permanent.

Updating the CLI

To update to the latest version:
groniz update
To check whether a newer version exists without installing it:
groniz update --check
groniz update --check exits with code 10 when a newer version is available and code 0 when you are already on the latest. This makes it suitable for use in CI scripts and pre-flight checks.

Agent Skill Installation

The groniz/groniz-cli skill is a short, structured prompt file that tells supported AI coding agents how to use the Groniz CLI correctly — covering authentication, media uploads, runtime settings discovery, and common failure traps that groniz --help does not address.

Auto-detect your agent

Run the following command from your project root. It inspects your project structure and installs the skill into the appropriate directory for each detected agent:
npx skills add groniz/groniz-cli

Target specific agents

To skip the detection prompt and install for specific agents only:
npx skills add groniz/groniz-cli -a claude-code -a opencode
Supported target names: claude-code, cline, cursor, opencode.

Install locations

AgentSkill location
Claude Code.claude/skills/
Cline.agents/skills/
Cursor.agents/skills/
OpenCode.agents/skills/
The skill file is committed alongside your project so every team member and CI environment that uses the same agent automatically picks it up.

What the skill teaches

Once installed, the skill instructs your agent to:
  • Authenticate before running any other command (stored credentials survive across sessions; export statements do not).
  • Call groniz upload and capture the returned .path before attaching media to a post.
  • Call groniz integrations settings <id> to discover per-channel character limits and required fields at runtime, rather than assuming platform defaults.
  • Avoid the common failure patterns: wrong JSON output shape, differing jq paths, thread syntax, draft-mode validation skipping, and the missing-release-id analytics gap.
npx requires Node.js to run the skills installer. This is a one-time setup step — the CLI itself does not need Node.js at runtime.

Requirements summary

ComponentRequirement
Groniz CLIcurl (pre-installed on all supported platforms)
Agent skillnpx / Node.js (install only)
RuntimeNone — CLI is a self-contained binary

Build docs developers (and LLMs) love