1Install the CLI
Install the DocubotAI CLI globally using npm:
npm install -g docubotai
After installation, you can use either docubotai
or the shorter alias docu
.
2Authenticate with your API key
Before using the CLI, you need to create an API Key from the DocubotAI web application:
- Visit https://docubotai.app/
- Sign up or log in to your account
- Navigate to your
API Keys
in the dashboard panel - Create your API key and copy it
Log in through CLI:
docu login
Choose an option how you want to be authenticated and pass your API Key:
- Enter API key manually
- Generate a new API key in browser
- Local development setup
3Generate Documentation
After successfully authenticated, run the following command to generate documentation:
docu generate-docs
Use your arrow keys to choose which project you want to generate documentation for.
Once completed, you can view your documentation in the projects pageDocubotAI web application.
4Additional Commands
View current status:
docu status
Remove specific files from the staging area:
docu remove src/deprecated/**/*.js
Clear all files from the staging area:
docu clear
View current configuration:
docu config
Set API key directly (alternative to login command):
docu config --key YOUR_API_KEY
Clear your stored API credentials:
docu logout
Login
docu login
Authenticate with DocubotAI API
Generate Documentation
docu generate-docs
Generate the documents
Configuration
docu config
View or set configuration values
Logout
docu logout
Clear stored API credentials
Status
docu status
Show files staged for documentation
List Projects
docu list-projects
Lists all available projects
For full documentation, use docu --help
or check our documentation.