CLI
Vikasit Code CLI options and commands.
The Vikasit Code CLI by default starts the TUI when run without any arguments.
vikasitBut it also accepts commands as documented on this page. This allows you to interact with Vikasit Code programmatically.
vikasit run "Explain how closures work in JavaScript"tui
Start the Vikasit Code terminal user interface.
vikasit [project]Flags
| Flag | Short | Description |
|---|---|---|
--continue | -c | Continue the last session |
--session | -s | Session ID to continue |
--fork | Fork the session when continuing (use with --continue or --session) | |
--prompt | Prompt to use | |
--model | -m | Model to use in the form of provider/model |
--agent | Agent to use | |
--port | Port to listen on | |
--hostname | Hostname to listen on |
Commands
The Vikasit Code CLI also has the following commands.
agent
Manage agents for Vikasit Code.
vikasit agent [command]attach
Attach a terminal to an already running Vikasit Code backend server started via serve or web commands.
vikasit attach [url]This allows using the TUI with a remote Vikasit Code backend. For example:
# Start the backend server for web/mobile accessvikasit web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendvikasit attach http://10.20.30.40:4096Flags
| Flag | Short | Description |
|---|---|---|
--dir | Working directory to start TUI in | |
--session | -s | Session ID to continue |
create
Create a new agent with custom configuration.
vikasit agent createThis command will guide you through creating a new agent with a custom system prompt and tool configuration.
list
List all available agents.
vikasit agent listauth
Command to manage credentials and login for providers.
vikasit auth [command]login
Use vikasit auth login to configure your Vikasit API key. This is stored in ~/.local/share/vikasit/auth.json.
vikasit auth loginWhen Vikasit Code starts up it loads the API key from the credentials file.
list
Lists the authenticated provider as stored in the credentials file.
vikasit auth listOr the short version.
vikasit auth lslogout
Logs you out by clearing credentials from the credentials file.
vikasit auth logoutgithub
Manage the GitHub agent for repository automation.
vikasit github [command]install
Install the GitHub agent in your repository.
vikasit github installThis sets up the necessary GitHub Actions workflow and guides you through the configuration process. Learn more.
run
Run the GitHub agent. This is typically used in GitHub Actions.
vikasit github runFlags
| Flag | Description |
|---|---|
--event | GitHub mock event to run the agent for |
--token | GitHub personal access token |
mcp
Manage Model Context Protocol servers.
vikasit mcp [command]add
Add an MCP server to your configuration.
vikasit mcp addThis command will guide you through adding either a local or remote MCP server.
list
List all configured MCP servers and their connection status.
vikasit mcp listOr use the short version.
vikasit mcp lsauth
Authenticate with an OAuth-enabled MCP server.
vikasit mcp auth [name]If you don’t provide a server name, you’ll be prompted to select from available OAuth-capable servers.
You can also list OAuth-capable servers and their authentication status.
vikasit mcp auth listOr use the short version.
vikasit mcp auth lslogout
Remove OAuth credentials for an MCP server.
vikasit mcp logout [name]debug
Debug OAuth connection issues for an MCP server.
vikasit mcp debug <name>models
List all available Vikasit models.
vikasit modelsThis command displays all 5 Vikasit models in the format vikasit/model.
This is useful for figuring out the exact model name to use in your config.
Flags
| Flag | Description |
|---|---|
--refresh | Refresh the models cache |
--verbose | Use more verbose model output (includes metadata like costs) |
Use the --refresh flag to update the cached model list.
vikasit models --refreshrun
Run vikasit in non-interactive mode by passing a prompt directly.
vikasit run [message..]This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.
vikasit run Explain the use of context in GoYou can also attach to a running vikasit serve instance to avoid MCP server cold boot times on every run:
# Start a headless server in one terminalvikasit serve
# In another terminal, run commands that attach to itvikasit run --attach http://localhost:4096 "Explain async/await in JavaScript"Flags
| Flag | Short | Description |
|---|---|---|
--command | The command to run, use message for args | |
--continue | -c | Continue the last session |
--session | -s | Session ID to continue |
--fork | Fork the session when continuing (use with --continue or --session) | |
--share | Share the session | |
--model | -m | Model to use in the form of provider/model |
--agent | Agent to use | |
--file | -f | File(s) to attach to message |
--format | Format: default (formatted) or json (raw JSON events) | |
--title | Title for the session (uses truncated prompt if no value provided) | |
--attach | Attach to a running vikasit server (e.g., http://localhost:4096) | |
--port | Port for the local server (defaults to random port) |
serve
Start a headless Vikasit Code server for API access. Check out the server docs for the full HTTP interface.
vikasit serveThis starts an HTTP server that provides API access to vikasit functionality without the TUI interface. Set VIKASIT_SERVER_PASSWORD to enable HTTP basic auth (username defaults to vikasit).
Flags
| Flag | Description |
|---|---|
--port | Port to listen on |
--hostname | Hostname to listen on |
--mdns | Enable mDNS discovery |
--cors | Additional browser origin(s) to allow CORS |
session
Manage Vikasit Code sessions.
vikasit session [command]list
List all Vikasit Code sessions.
vikasit session listFlags
| Flag | Short | Description |
|---|---|---|
--max-count | -n | Limit to N most recent sessions |
--format | Output format: table or json (table) |
stats
Show token usage and cost statistics for your Vikasit Code sessions.
vikasit statsFlags
| Flag | Description |
|---|---|
--days | Show stats for the last N days (all time) |
--tools | Number of tools to show (all) |
--models | Show model usage breakdown (hidden by default). Pass a number to show top N |
--project | Filter by project (all projects, empty string: current project) |
export
Export session data as JSON.
vikasit export [sessionID]If you don’t provide a session ID, you’ll be prompted to select from available sessions.
import
Import session data from a JSON file or Vikasit Code share URL.
vikasit import <file>You can import from a local file or a Vikasit Code share URL.
vikasit import session.jsonvikasit import https://vikasit.ai/s/abc123web
Start a headless Vikasit Code server with a web interface.
vikasit webThis starts an HTTP server and opens a web browser to access Vikasit Code through a web interface. Set VIKASIT_SERVER_PASSWORD to enable HTTP basic auth (username defaults to vikasit).
Flags
| Flag | Description |
|---|---|
--port | Port to listen on |
--hostname | Hostname to listen on |
--mdns | Enable mDNS discovery |
--cors | Additional browser origin(s) to allow CORS |
acp
Start an ACP (Agent Client Protocol) server.
vikasit acpThis command starts an ACP server that communicates via stdin/stdout using nd-JSON.
Flags
| Flag | Description |
|---|---|
--cwd | Working directory |
--port | Port to listen on |
--hostname | Hostname to listen on |
uninstall
Uninstall Vikasit Code and remove all related files.
vikasit uninstallFlags
| Flag | Short | Description |
|---|---|---|
--keep-config | -c | Keep configuration files |
--keep-data | -d | Keep session data and snapshots |
--dry-run | Show what would be removed without removing | |
--force | -f | Skip confirmation prompts |
upgrade
Updates vikasit to the latest version or a specific version.
vikasit upgrade [target]To upgrade to the latest version.
vikasit upgradeTo upgrade to a specific version.
vikasit upgrade v0.1.48Flags
| Flag | Short | Description |
|---|---|---|
--method | -m | The installation method that was used; curl, npm, pnpm, bun, brew |
Global Flags
The vikasit CLI takes the following global flags.
| Flag | Short | Description |
|---|---|---|
--help | -h | Display help |
--version | -v | Print version number |
--print-logs | Print logs to stderr | |
--log-level | Log level (DEBUG, INFO, WARN, ERROR) |
Environment variables
Vikasit Code can be configured using environment variables.
| Variable | Type | Description |
|---|---|---|
VIKASIT_AUTO_SHARE | boolean | Automatically share sessions |
VIKASIT_GIT_BASH_PATH | string | Path to Git Bash executable on Windows |
VIKASIT_CONFIG | string | Path to config file |
VIKASIT_TUI_CONFIG | string | Path to TUI config file |
VIKASIT_CONFIG_DIR | string | Path to config directory |
VIKASIT_CONFIG_CONTENT | string | Inline json config content |
VIKASIT_DISABLE_AUTOUPDATE | boolean | Disable automatic update checks |
VIKASIT_DISABLE_PRUNE | boolean | Disable pruning of old data |
VIKASIT_DISABLE_TERMINAL_TITLE | boolean | Disable automatic terminal title updates |
VIKASIT_PERMISSION | string | Inlined json permissions config |
VIKASIT_DISABLE_DEFAULT_PLUGINS | boolean | Disable default plugins |
VIKASIT_DISABLE_LSP_DOWNLOAD | boolean | Disable automatic LSP server downloads |
VIKASIT_ENABLE_EXPERIMENTAL_MODELS | boolean | Enable experimental models |
VIKASIT_DISABLE_AUTOCOMPACT | boolean | Disable automatic context compaction |
VIKASIT_DISABLE_CLAUDE_CODE | boolean | Disable reading from .claude (prompt + skills) |
VIKASIT_DISABLE_CLAUDE_CODE_PROMPT | boolean | Disable reading ~/.claude/CLAUDE.md |
VIKASIT_DISABLE_CLAUDE_CODE_SKILLS | boolean | Disable loading .claude/skills |
VIKASIT_DISABLE_MODELS_FETCH | boolean | Disable fetching models from remote sources |
VIKASIT_FAKE_VCS | string | Fake VCS provider for testing purposes |
VIKASIT_DISABLE_FILETIME_CHECK | boolean | Disable file time checking for optimization |
VIKASIT_CLIENT | string | Client identifier (defaults to cli) |
VIKASIT_ENABLE_EXA | boolean | Enable Exa web search tools |
VIKASIT_SERVER_PASSWORD | string | Enable basic auth for serve/web |
VIKASIT_SERVER_USERNAME | string | Override basic auth username (default vikasit) |
VIKASIT_MODELS_URL | string | Custom URL for fetching models configuration |
Experimental
These environment variables enable experimental features that may change or be removed.
| Variable | Type | Description |
|---|---|---|
VIKASIT_EXPERIMENTAL | boolean | Enable all experimental features |
VIKASIT_EXPERIMENTAL_ICON_DISCOVERY | boolean | Enable icon discovery |
VIKASIT_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Disable copy on select in TUI |
VIKASIT_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | Default timeout for bash commands in ms |
VIKASIT_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | Max output tokens for LLM responses |
VIKASIT_EXPERIMENTAL_FILEWATCHER | boolean | Enable file watcher for entire dir |
VIKASIT_EXPERIMENTAL_OXFMT | boolean | Enable oxfmt formatter |
VIKASIT_EXPERIMENTAL_LSP_TOOL | boolean | Enable experimental LSP tool |
VIKASIT_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Disable file watcher |
VIKASIT_EXPERIMENTAL_EXA | boolean | Enable experimental Exa features |
VIKASIT_EXPERIMENTAL_LSP_TY | boolean | Enable TY LSP for python files |
VIKASIT_EXPERIMENTAL_MARKDOWN | boolean | Enable experimental markdown features |
VIKASIT_EXPERIMENTAL_PLAN_MODE | boolean | Enable plan mode |