CLI Usage
Command-line options and workflows for the dorkos CLI
CLI Usage
The dorkos CLI bundles the server and client into a single command. Install globally and run from any project directory.
npm install -g dorkosQuick Start
export ANTHROPIC_API_KEY=your-key-here
dorkosThe server starts on port 4242 and opens your browser automatically.
Command-Line Flags
Prop
Type
Examples
# Start on a custom port
dorkos --port 8080
# Start with a specific project directory
dorkos --dir /path/to/my/project
# Restrict file access to a project directory
dorkos --boundary /home/user/projects
# Enable tunnel for remote access
dorkos --tunnelSubcommands
dorkos config
Manage persistent configuration stored at ~/.dork/config.json.
dorkos config # Show all effective settings
dorkos config get <key> # Get a single config value
dorkos config set <key> <value> # Set a single config value
dorkos config list # Full JSON output
dorkos config reset [key] # Reset all or a specific key to defaults
dorkos config edit # Open config in $EDITOR
dorkos config path # Print config file location
dorkos config validate # Check config validitydorkos init
Interactive setup wizard for first-time configuration. Walks you through setting your API key, default port, and working directory.
dorkos init
dorkos init --yes # Accept all defaultsConfig Directory
On first run, DorkOS creates ~/.dork/ for persistent storage:
Environment Variables
Prop
Type
Config Precedence
Configuration is resolved in this order (highest priority first):
- CLI flags (
--port,--dir, etc.) - Environment variables (
DORKOS_PORT, etc.) - Config file (
~/.dork/config.json) - Built-in defaults
Use dorkos config to view the resolved configuration and see which values come from which source.
Automatic Update Checks
DorkOS checks the npm registry for new versions each time it starts. If a newer version is available, you will see a notification in the terminal:
┌───────────────────────────────────────┐
│ Update available: 0.2.0 → 0.3.0 │
│ Run npm install -g dorkos@latest │
└───────────────────────────────────────┘The check runs in the background with a 3-second timeout and caches results for 24 hours, so it never slows down startup. To update manually:
npm install -g dorkos@latest