Skip to main content

​
Installation

Install CodeAnt CLI globally using npm: 
npm install -g codeant-cli
Verify the installation: 
codeant --version
codeant --help

​
Authentication

​
Login with CodeAnt AI

Authenticate with your CodeAnt AI account using browser-based OAuth: 
codeant login
This opens a browser window at app.codeant.ai for authentication. The CLI polls for login completion automatically (timeout: 10 minutes). Your API key is saved to ~/.codeant/config.json. To log out: 
codeant logout

​
SCM Platform Tokens

To use PR management and code review features, store authentication tokens for your SCM platform: 
codeant set-token github <your-github-token>
codeant set-token gitlab <your-gitlab-token>
codeant set-token bitbucket <your-bitbucket-token>
codeant set-token azure <your-azure-devops-pat>
Alternative: Environment Variables You can also authenticate via environment variables (these take priority over stored tokens):
PlatformEnvironment Variables
GitHubGITHUB_TOKEN, GH_TOKEN
GitLabGITLAB_TOKEN
BitbucketBITBUCKET_TOKEN
Azure DevOpsAZURE_DEVOPS_TOKEN, AZURE_DEVOPS_PAT
Alternative: Platform CLI Tools If you have GitHub CLI (gh) or GitLab CLI (glab) installed and authenticated, CodeAnt will automatically use their tokens as a fallback. Token Resolution Order:
  1. Environment variables (highest priority)
  2. Platform CLI tools (gh auth token, glab auth token)
  3. Stored tokens in ~/.codeant/config.json

​
Self-Hosted / Enterprise Setup

​
Custom API Base URL

For self-hosted CodeAnt deployments, set a custom API base URL: 
codeant set-base-url https://your-codeant-instance.example.com
Check the current API base URL and its source: 
codeant get-base-url
You can also set this via the CODEANT_API_URL environment variable.

​
Self-Hosted SCM Platforms

CodeAnt auto-detects self-hosted SCM instances from your git remote URL. You can also explicitly configure base URLs:
PlatformEnvironment VariablesConfig Key
GitHub EnterpriseGITHUB_API_URL, GH_ENTERPRISE_URLgithubBaseUrl
Self-hosted GitLabGITLAB_URL, GITLAB_HOSTgitlabBaseUrl
Bitbucket ServerBITBUCKET_URL, BITBUCKET_SERVER_URLbitbucketBaseUrl

​
Quick Start

Once installed and authenticated, try scanning your staged files: 
# Scan for secrets
codeant secrets

# AI-powered code review
codeant review
See the Commands reference for all available options.