Skip to content

CLI

Vikasit Code CLI options and commands.

The Vikasit Code CLI by default starts the TUI when run without any arguments.

Terminal window
vikasit

But it also accepts commands as documented on this page. This allows you to interact with Vikasit Code programmatically.

Terminal window
vikasit run "Explain how closures work in JavaScript"

tui

Start the Vikasit Code terminal user interface.

Terminal window
vikasit [project]

Flags

FlagShortDescription
--continue-cContinue the last session
--session-sSession ID to continue
--forkFork the session when continuing (use with --continue or --session)
--promptPrompt to use
--model-mModel to use in the form of provider/model
--agentAgent to use
--portPort to listen on
--hostnameHostname to listen on

Commands

The Vikasit Code CLI also has the following commands.


agent

Manage agents for Vikasit Code.

Terminal window
vikasit agent [command]

attach

Attach a terminal to an already running Vikasit Code backend server started via serve or web commands.

Terminal window
vikasit attach [url]

This allows using the TUI with a remote Vikasit Code backend. For example:

Terminal window
# Start the backend server for web/mobile access
vikasit web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
vikasit attach http://10.20.30.40:4096

Flags

FlagShortDescription
--dirWorking directory to start TUI in
--session-sSession ID to continue

create

Create a new agent with custom configuration.

Terminal window
vikasit agent create

This command will guide you through creating a new agent with a custom system prompt and tool configuration.


list

List all available agents.

Terminal window
vikasit agent list

auth

Command to manage credentials and login for providers.

Terminal window
vikasit auth [command]

login

Use vikasit auth login to configure your Vikasit API key. This is stored in ~/.local/share/vikasit/auth.json.

Terminal window
vikasit auth login

When Vikasit Code starts up it loads the API key from the credentials file.


list

Lists the authenticated provider as stored in the credentials file.

Terminal window
vikasit auth list

Or the short version.

Terminal window
vikasit auth ls

logout

Logs you out by clearing credentials from the credentials file.

Terminal window
vikasit auth logout

github

Manage the GitHub agent for repository automation.

Terminal window
vikasit github [command]

install

Install the GitHub agent in your repository.

Terminal window
vikasit github install

This 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.

Terminal window
vikasit github run
Flags
FlagDescription
--eventGitHub mock event to run the agent for
--tokenGitHub personal access token

mcp

Manage Model Context Protocol servers.

Terminal window
vikasit mcp [command]

add

Add an MCP server to your configuration.

Terminal window
vikasit mcp add

This command will guide you through adding either a local or remote MCP server.


list

List all configured MCP servers and their connection status.

Terminal window
vikasit mcp list

Or use the short version.

Terminal window
vikasit mcp ls

auth

Authenticate with an OAuth-enabled MCP server.

Terminal window
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.

Terminal window
vikasit mcp auth list

Or use the short version.

Terminal window
vikasit mcp auth ls

logout

Remove OAuth credentials for an MCP server.

Terminal window
vikasit mcp logout [name]

debug

Debug OAuth connection issues for an MCP server.

Terminal window
vikasit mcp debug <name>

models

List all available Vikasit models.

Terminal window
vikasit models

This 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

FlagDescription
--refreshRefresh the models cache
--verboseUse more verbose model output (includes metadata like costs)

Use the --refresh flag to update the cached model list.

Terminal window
vikasit models --refresh

run

Run vikasit in non-interactive mode by passing a prompt directly.

Terminal window
vikasit run [message..]

This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.

Terminal window
vikasit run Explain the use of context in Go

You can also attach to a running vikasit serve instance to avoid MCP server cold boot times on every run:

Terminal window
# Start a headless server in one terminal
vikasit serve
# In another terminal, run commands that attach to it
vikasit run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flags

FlagShortDescription
--commandThe command to run, use message for args
--continue-cContinue the last session
--session-sSession ID to continue
--forkFork the session when continuing (use with --continue or --session)
--shareShare the session
--model-mModel to use in the form of provider/model
--agentAgent to use
--file-fFile(s) to attach to message
--formatFormat: default (formatted) or json (raw JSON events)
--titleTitle for the session (uses truncated prompt if no value provided)
--attachAttach to a running vikasit server (e.g., http://localhost:4096)
--portPort 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.

Terminal window
vikasit serve

This 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

FlagDescription
--portPort to listen on
--hostnameHostname to listen on
--mdnsEnable mDNS discovery
--corsAdditional browser origin(s) to allow CORS

session

Manage Vikasit Code sessions.

Terminal window
vikasit session [command]

list

List all Vikasit Code sessions.

Terminal window
vikasit session list
Flags
FlagShortDescription
--max-count-nLimit to N most recent sessions
--formatOutput format: table or json (table)

stats

Show token usage and cost statistics for your Vikasit Code sessions.

Terminal window
vikasit stats

Flags

FlagDescription
--daysShow stats for the last N days (all time)
--toolsNumber of tools to show (all)
--modelsShow model usage breakdown (hidden by default). Pass a number to show top N
--projectFilter by project (all projects, empty string: current project)

export

Export session data as JSON.

Terminal window
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.

Terminal window
vikasit import <file>

You can import from a local file or a Vikasit Code share URL.

Terminal window
vikasit import session.json
vikasit import https://vikasit.ai/s/abc123

web

Start a headless Vikasit Code server with a web interface.

Terminal window
vikasit web

This 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

FlagDescription
--portPort to listen on
--hostnameHostname to listen on
--mdnsEnable mDNS discovery
--corsAdditional browser origin(s) to allow CORS

acp

Start an ACP (Agent Client Protocol) server.

Terminal window
vikasit acp

This command starts an ACP server that communicates via stdin/stdout using nd-JSON.

Flags

FlagDescription
--cwdWorking directory
--portPort to listen on
--hostnameHostname to listen on

uninstall

Uninstall Vikasit Code and remove all related files.

Terminal window
vikasit uninstall

Flags

FlagShortDescription
--keep-config-cKeep configuration files
--keep-data-dKeep session data and snapshots
--dry-runShow what would be removed without removing
--force-fSkip confirmation prompts

upgrade

Updates vikasit to the latest version or a specific version.

Terminal window
vikasit upgrade [target]

To upgrade to the latest version.

Terminal window
vikasit upgrade

To upgrade to a specific version.

Terminal window
vikasit upgrade v0.1.48

Flags

FlagShortDescription
--method-mThe installation method that was used; curl, npm, pnpm, bun, brew

Global Flags

The vikasit CLI takes the following global flags.

FlagShortDescription
--help-hDisplay help
--version-vPrint version number
--print-logsPrint logs to stderr
--log-levelLog level (DEBUG, INFO, WARN, ERROR)

Environment variables

Vikasit Code can be configured using environment variables.

VariableTypeDescription
VIKASIT_AUTO_SHAREbooleanAutomatically share sessions
VIKASIT_GIT_BASH_PATHstringPath to Git Bash executable on Windows
VIKASIT_CONFIGstringPath to config file
VIKASIT_TUI_CONFIGstringPath to TUI config file
VIKASIT_CONFIG_DIRstringPath to config directory
VIKASIT_CONFIG_CONTENTstringInline json config content
VIKASIT_DISABLE_AUTOUPDATEbooleanDisable automatic update checks
VIKASIT_DISABLE_PRUNEbooleanDisable pruning of old data
VIKASIT_DISABLE_TERMINAL_TITLEbooleanDisable automatic terminal title updates
VIKASIT_PERMISSIONstringInlined json permissions config
VIKASIT_DISABLE_DEFAULT_PLUGINSbooleanDisable default plugins
VIKASIT_DISABLE_LSP_DOWNLOADbooleanDisable automatic LSP server downloads
VIKASIT_ENABLE_EXPERIMENTAL_MODELSbooleanEnable experimental models
VIKASIT_DISABLE_AUTOCOMPACTbooleanDisable automatic context compaction
VIKASIT_DISABLE_CLAUDE_CODEbooleanDisable reading from .claude (prompt + skills)
VIKASIT_DISABLE_CLAUDE_CODE_PROMPTbooleanDisable reading ~/.claude/CLAUDE.md
VIKASIT_DISABLE_CLAUDE_CODE_SKILLSbooleanDisable loading .claude/skills
VIKASIT_DISABLE_MODELS_FETCHbooleanDisable fetching models from remote sources
VIKASIT_FAKE_VCSstringFake VCS provider for testing purposes
VIKASIT_DISABLE_FILETIME_CHECKbooleanDisable file time checking for optimization
VIKASIT_CLIENTstringClient identifier (defaults to cli)
VIKASIT_ENABLE_EXAbooleanEnable Exa web search tools
VIKASIT_SERVER_PASSWORDstringEnable basic auth for serve/web
VIKASIT_SERVER_USERNAMEstringOverride basic auth username (default vikasit)
VIKASIT_MODELS_URLstringCustom URL for fetching models configuration

Experimental

These environment variables enable experimental features that may change or be removed.

VariableTypeDescription
VIKASIT_EXPERIMENTALbooleanEnable all experimental features
VIKASIT_EXPERIMENTAL_ICON_DISCOVERYbooleanEnable icon discovery
VIKASIT_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDisable copy on select in TUI
VIKASIT_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDefault timeout for bash commands in ms
VIKASIT_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMax output tokens for LLM responses
VIKASIT_EXPERIMENTAL_FILEWATCHERbooleanEnable file watcher for entire dir
VIKASIT_EXPERIMENTAL_OXFMTbooleanEnable oxfmt formatter
VIKASIT_EXPERIMENTAL_LSP_TOOLbooleanEnable experimental LSP tool
VIKASIT_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDisable file watcher
VIKASIT_EXPERIMENTAL_EXAbooleanEnable experimental Exa features
VIKASIT_EXPERIMENTAL_LSP_TYbooleanEnable TY LSP for python files
VIKASIT_EXPERIMENTAL_MARKDOWNbooleanEnable experimental markdown features
VIKASIT_EXPERIMENTAL_PLAN_MODEbooleanEnable plan mode