@docnineai/cli
v1.0.0
Published
AI-powered documentation, security auditing, and codebase Q&A in your terminal
Maintainers
Readme
Docnine CLI
An AI-powered documentation tool for developers and Project Manager in your terminal.
npm install -g docnineCommands
Setup
docnine login
docnine login --token <token>
docnine logout
docnine whoami
docnine initCore
docnine generate
docnine generate --watch
docnine generate --format md
docnine ask "how does auth work?"
docnine ask --file src/auth.js
docnine ask --interactive
docnine audit
docnine audit --fail-on CRITICAL
docnine audit --fail-on HIGH
docnine audit --format json
docnine audit --format sarif
docnine diff
docnine diff --since v1.2.0
docnine diff --since HEAD~10
docnine diff --format json
docnine export --format openapi
docnine export --format postman
docnine export --format markdown
docnine export --format pdf
docnine export --out ./exportsCI/CD
docnine ci
docnine ci --fail-on HIGH
docnine ci --comment-pr
docnine ci --format jsonlogged in + linked project. Files are sent to Docnine server for full pipeline processing.
File Collection Rules
- Recursively scans current directory
- Respects
.gitignoreand.docnineignore - Skips:
node_modules,.git,dist,build,coverage,*.min.js - Collects:
.js .ts .tsx .jsx .py .go .rs .java .prisma .graphql .sql
Config Files
Auth config (~/.docnine/config.json, chmod 600):
{
"token": "...",
"user": {
"id": "...",
"email": "[email protected]",
"name": "Your Name",
"plan": "pro"
}
}Project config (.docnine.json):
{
"projectId": "...",
"outputDir": "./docs",
"offline": false
}Run snapshot (.docnine/last-run.json): used by diff, export, and ci.
Environment Variables
DOCNINE_API_URL(default:https://api.docnineai.com)DOCNINE_URL(default:https://docnineai.com)DOCNINE_API_TOKEN(optional token fallback)
The CLI auto-loads .env from the current working directory (for example DOCNINE_API_URL=http://localhost:3000).
Exit Codes
0on success1on command error or fail threshold exceeded
