Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unideploy.in/llms.txt

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

​
Requirements

  • Node.js 18 or higher
  • npm 8 or higher

​
Install

npm install -g unideploy
Verify the installation: 
unideploy --version

​
Authenticate

UniDeploy uses an API key for authentication. Get your key from the dashboard under Settings → API Keys. Set it as an environment variable: 
export UNIDEPLOY_API_KEY=ud_live_...
To persist it across sessions, add it to your shell profile (~/.zshrc, ~/.bashrc, etc.): 
echo 'export UNIDEPLOY_API_KEY=ud_live_...' >> ~/.zshrc
source ~/.zshrc

​
Verify authentication

unideploy scan --local
If authentication is configured correctly, the CLI will detect your project and begin scanning.

​
Updating

npm update -g unideploy