ngodingpakeai
v0.6.0
Published
Official CLI for NgodingPakeAI — safely scan, index, and sync your codebase context to a NgodingPakeAI workspace.
Maintainers
Readme
ngodingpakeai
Official command-line client for NgodingPakeAI — the project-memory and codebase-context layer for AI coding agents.
The CLI is the privacy gate: it scans your repo locally, enforces
deterministic path-based ignore rules, and syncs only file metadata plus
summaries written locally by your AI coding agent. Raw source code, .env
files, keys, node_modules, and build output are never uploaded.
Install
Run without installing:
npx ngodingpakeai doctorOr install globally:
npm i -g ngodingpakeaiRequires Node.js >= 18.17.
Authentication
NgodingPakeAI uses access tokens (ngpk_…). The easiest way to authenticate is
the browser flow:
ngodingpakeai loginThis opens the web app, you approve, and an account-scoped token (valid across
all your workspaces) is saved to ~/.ngodingpakeai/config.json (mode 0600).
Headless / CI — pass a token directly (no browser):
ngodingpakeai login --token ngpk_xxxxxxxxOr skip login entirely and pass credentials via env:
export NGODINGPAKEAI_TOKEN=ngpk_xxxxxxxx
export NGODINGPAKEAI_API_URL=https://www.ngodingpakeai.com # optional override
ngodingpakeai sync --workspace <workspace-uuid> --yesMint a token manually in the web app: Workspace → Settings → Access tokens. The plaintext is shown once — copy it immediately.
Usage
cd your-project
ngodingpakeai connect # register this folder as a repo in the workspace
ngodingpakeai index # preview locally what would sync (no upload)
ngodingpakeai sync --plan # upload metadata; create pending summary list
ngodingpakeai sync # upload agent-written summaries
ngodingpakeai status # see repos + last sync stateCommands
| Command | Description |
| --- | --- |
| login | Log in via browser, or --token to save a token headless. |
| logout | Remove a stored token (--all for every workspace). |
| init | Install the skill for your AI agent (Claude/Codex/Antigravity/Cursor) + AGENTS.md. |
| bootstrap | Consume a one-time copied-prompt token and create/bind a project from this repo. |
| connect | Register the current folder as a repo (detects git remote / provider). |
| index | Local scan → .ngodingpakeai/index/latest.json. No network. |
| sync --plan | Upload metadata and write .ngodingpakeai/pending.json. |
| sync | Validate and upload agent-written file/section summaries. |
| status | List workspace repos and their latest sync run. |
| plan get <id> | Print a plan's PRD (markdown) for agent context. |
| task list | Discover open tasks across your plans (--json for scripting). |
| task get <id> | Print a task's full prompt to run. |
| task start\|complete\|fail <id> | Update a task's status. |
| task reset <id> [reason] | Return a task to todo; completed tasks ask for confirmation. |
| disconnect | Unbind this folder (server data untouched). |
| doctor | Diagnose environment, auth, and connectivity. |
AI agent workflow
init installs a skill so your coding agent (Claude Code, Codex, Cursor,
Antigravity) knows how to pull plans and tasks from NgodingPakeAI:
ngodingpakeai init # auto-detects your agent; writes the skill + AGENTS.md
ngodingpakeai plan get <id> # PRD context for a plan
ngodingpakeai task list # find open work
ngodingpakeai task get <id> # the prompt to run, then start/complete/fail itSummary-only privacy model
There is one mode. The CLI uploads file metadata and natural-language summaries. Source files are read only on the user's machine by the coding agent. The server embeds summaries and cannot quote or reconstruct raw source code.
What never leaves your machine
Hard-blocked regardless of .gitignore / .ngodingpakeaiignore:
.env, .env.* node_modules/ dist/ build/ out/ .next/ ...
*.pem *.key *.p12 .git/ coverage/ logs/ *.log
*.sqlite *.db vendor/ .venv/Add project-specific exclusions in .ngodingpakeaiignore (gitignore syntax,
created automatically on first connect).
Local config
~/.ngodingpakeai/config.json— API url + per-workspace tokens (secret,0600).<project>/.ngodingpakeai/config.json— workspace/repo binding (ids only; safe to commit).
Environment variables
| Variable | Purpose |
| --- | --- |
| NGODINGPAKEAI_TOKEN | Access token override (CI/headless). |
| NGODINGPAKEAI_API_URL | API base url override. |
| NGODINGPAKEAI_YES=1 | Auto-confirm prompts. |
| NGODINGPAKEAI_DEBUG=1 | Print full stack traces on error. |
Development
pnpm install
pnpm build # bundle to dist/ (tsup, ESM, with shebang)
pnpm typecheck
node dist/index.js --helpLicense
MIT
