Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.driftless.icu/llms.txt

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

​
Install

npm install -g @driftless-sh/cli

​
Authenticate

Run driftless login to open your browser to the Driftless dashboard, where you can copy your API key: 
driftless login
For non-interactive environments (e.g., CI), pass the key directly: 
driftless login --key drift_xxxxxxxxxxxxxxxxx

​
Initialize a repo

driftless init
driftless init scans the current repository, uploads a baseline to Driftless Cloud, and installs the agent skill (AGENTS.md + CLAUDE.md) so agents automatically load context before editing. See Agent Setup for details.
Set DRIFTLESS_API_KEY for non-interactive environments. Set DRIFTLESS_API_URL only when targeting staging or a local API.

​
Config File

The CLI stores its state in ~/.driftless/config.json: 
{
  "api_key": "drift_xxxxxxxxxxxxxxxxx",
  "api_url": "https://api.driftless.icu/api/v1",
  "workspace_slug": "acme-corp",
  "workspace_id": "ws_abc123"
}

​
Command reference

CommandFlagsDescriptionExample
login--key <key>, --url <url>Authenticate with API keydriftless login --key drift_xxx
init--src <path>, --framework <fw>, --suggestScan repo, upload baseline, install skilldriftless init --src apps/api --suggest
doctor--json8 health checksdriftless doctor
install-skillnoneInstall AGENTS.md + CLAUDE.mddriftless install-skill

​
Global flags

FlagDescription
--version / -vPrint version
--help / -hFull help
<cmd> --helpCommand-specific help
VariableDescription
DRIFTLESS_API_KEYAPI key (wins over config file)
DRIFTLESS_API_URLAPI server URL (default: https://api.driftless.icu/api/v1)
DRIFTLESS_MAX_FILE_BYTESPer-file scan cap for the scanner