CLI Usage
Command-line flags, subcommands, and configuration 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 --tunnel
# Enable Task scheduler
dorkos --tasks
# Verbose logging
dorkos --log-level debugSubcommands
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 through API key, default port, and working directory.
dorkos init
dorkos init --yes # Accept all defaultsdorkos install / dorkos uninstall / dorkos update
Install, remove, and update marketplace packages.
dorkos install <package> # Install from any configured source
dorkos install <package> --yes # Skip confirmation prompt
dorkos uninstall <package> # Remove an installed package
dorkos update # Check all installed packages for updates
dorkos update <package> --apply # Apply an available updatedorkos marketplace
Manage the marketplace sources that list available packages.
dorkos marketplace list [<source>] # Browse available packages
dorkos marketplace add <url-or-path> # Register a new source
dorkos marketplace remove <name> # Remove a source
dorkos marketplace refresh [<source>] # Force-refresh source package listingdorkos package
Scaffold and validate marketplace packages for publishing.
dorkos package init <name> --type plugin|agent|skill-pack|adapter
dorkos package validate <path>dorkos cache
Manage the package clone cache at ~/.dork/cache/.
dorkos cache prune [--keep <N>] # Remove old cached versions
dorkos cache clear # Wipe the entire cacheConfig 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
Run dorkos config to view the resolved configuration and see which values come from which
source.
Docker
Run DorkOS in a Docker container without a local Node.js install:
# From the repository (development)
pnpm docker:build
pnpm docker:run
# Or directly
docker build -f Dockerfile.run -t dorkos:local .
docker run --rm -p 4242:4242 -e ANTHROPIC_API_KEY=your-key dorkos:localThe container binds to 0.0.0.0 automatically for Docker port forwarding.
Automatic Update Checks
DorkOS checks the npm registry for new versions at startup. When a newer version is available, you'll 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. To update:
npm install -g dorkos@latest