Skip to content

Repository files navigation

NeetoPlanner CLI

A command-line interface for NeetoPlanner. Manage projects, lists and todos, and set per-workspace defaults.

Status: login, logout, whoami, doctor, version, commands, completion and setup work today. The projects, lists and todos commands are registered with their final flags and help text, but each one exits with a message naming the endpoint it is waiting on — the NeetoPlanner external API is still being built. Track neeto-planner-web#12675.

Command reference

neetoplanner projects list
neetoplanner lists list [--project <p>]
neetoplanner todos list [--project <p>] [--list <l>]
neetoplanner todos show <id>
neetoplanner todos create "Ship it" [--project <p>] [--list <l>]
neetoplanner todos update <id> [--title ...]
neetoplanner todos done <id>
neetoplanner config set default-project <p>

--project accepts a project name or ID. Commands resolve it in this order: the --project flag, then NEETOPLANNER_PROJECT, then the default saved per subdomain by neetoplanner config set default-project.

Installation

macOS / Linux

Homebrew (recommended on macOS):

brew install neetozone/tap/neetoplanner

Shell script:

curl -fsSL https://neeto-downloads.s3.amazonaws.com/cli/NeetoPlanner/latest/install.sh | sh

This verifies the download's SHA-256 checksum against the published SHA256SUMS, then installs to /usr/local/bin (may prompt for sudo). Set NEETOPLANNER_INSTALL_DIR to a directory you own to install without sudo.

Windows

PowerShell:

irm https://neeto-downloads.s3.amazonaws.com/cli/NeetoPlanner/latest/install.ps1 | iex

Command Prompt (CMD):

curl -fsSL https://neeto-downloads.s3.amazonaws.com/cli/NeetoPlanner/latest/install.cmd -o install.cmd && install.cmd

Both verify the download's SHA-256 checksum before installing to %LOCALAPPDATA%\Programs\neetoplanner and adding it to your user PATH. Set NEETOPLANNER_INSTALL_DIR to install somewhere else.

Verify installation

neetoplanner --help

AI coding assistants

neetoplanner setup claude      # Register plugin with Claude Code
neetoplanner setup cursor      # Write .cursor/rules/neetoplanner.mdc
neetoplanner setup windsurf    # Write .windsurf/rules/neetoplanner.md
neetoplanner setup copilot     # Add a NeetoPlanner section to .github/copilot-instructions.md
neetoplanner setup gemini      # Add a NeetoPlanner section to GEMINI.md
neetoplanner setup codex       # Add a NeetoPlanner section to AGENTS.md

Every command except setup claude writes into the current project directory, so run these commands from the root of the project the assistant works in. Re-run them after every upgrade: setup cursor and setup windsurf overwrite their rule file, while setup copilot, setup gemini and setup codex keep the existing content of their file and replace only the NeetoPlanner section instead of adding a duplicate.

Prerequisites (development)

  • Go 1.26.1+
  • Access to a NeetoPlanner organization

Development

git clone https://github.com/neetozone/neeto-planner-cli.git
cd neeto-planner-cli
bin/setup

This installs Go dependencies, golangci-lint, configures git hooks, and builds the binary.

Make targets

make build          # Builds ./neetoplanner
make test           # Run tests
make lint           # golangci-lint
make fmt            # gofmt -w
make vet            # go vet
make check          # fmt + vet + test
make install        # Installs to /usr/local/bin
make clean          # Remove built binary

Pointing to a local or staging server

Set NEETOPLANNER_BASE_URL to override the default https://<subdomain>.neetoplanner.com:

export NEETOPLANNER_BASE_URL=http://spinkart.lvh.me:8830
neetoplanner login --subdomain spinkart

Global flags

Every command accepts:

Flag Description
--subdomain <name> Which logged-in subdomain to use (required when multiple are logged in).
--json Force JSON envelope output.
--quiet Emit raw data only. Action commands print just the identifier; delete prints success.
--toon TOON (Token-Optimized Output Notation) — compact format for LLMs.
--verbose Expand every field of a record instead of a table.

Adding product-specific commands

See docs/adding-commands.md for the step-by-step workflow for adding new resource commands that use the built-in auth, HTTP client, and output helpers.

Quick API wrapper reference: docs/api-wrapper-reference.md.

Release

Releases are cut by the CI pipeline defined in .neetoci/release.yml.

Merging a PR with a major, minor, or patch label to main triggers the shared release script from neeto-cli-commons. The script:

  • Bumps and tags VERSION
  • Runs GoReleaser
  • Uploads artifacts to s3://neeto-downloads/cli/NeetoPlanner/
  • Updates the Homebrew tap (neetozone/tap)
  • Pushes the version bump commit to main

About

NeetoPlanner CLI

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages