Skip to content

CLI

t-req CLI options and commands.

The t-req CLI by default starts the TUI when run without any arguments.

Terminal window
treq

But it also accepts commands as documented on this page. This allows you to interact with t-req programmatically.

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

tui

Start the t-req terminal user interface.

Terminal window
treq [project]

Flags

FlagShortDescription
--continue-cContinue the last session
--session-sSession ID to continue
--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 t-req CLI also has the following commands.


agent

Manage agents for t-req.

Terminal window
treq agent [command]

attach

Attach a terminal to an already running t-req backend server started via serve or web commands.

Terminal window
treq attach [url]

This allows using the TUI with a remote t-req backend. For example:

Terminal window
# Start the backend server for web/mobile access
treq web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
treq 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
treq 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
treq agent list

auth

Command to manage credentials and login for providers.

Terminal window
treq auth [command]

login

t-req is powered by the provider list at Models.dev, so you can use treq auth login to configure API keys for any provider you’d like to use. This is stored in ~/.local/share/treq/auth.json.

Terminal window
treq auth login

When t-req starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a .env file in your project.


list

Lists all the authenticated providers as stored in the credentials file.

Terminal window
treq auth list

Or the short version.

Terminal window
treq auth ls

logout

Logs you out of a provider by clearing it from the credentials file.

Terminal window
treq auth logout

github

Manage the GitHub agent for repository automation.

Terminal window
treq github [command]

install

Install the GitHub agent in your repository.

Terminal window
treq 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
treq github run
Flags
FlagDescription
--eventGitHub mock event to run the agent for
--tokenGitHub personal access token

mcp

Manage Model Context Protocol servers.

Terminal window
treq mcp [command]

add

Add an MCP server to your configuration.

Terminal window
treq 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
treq mcp list

Or use the short version.

Terminal window
treq mcp ls

auth

Authenticate with an OAuth-enabled MCP server.

Terminal window
treq 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
treq mcp auth list

Or use the short version.

Terminal window
treq mcp auth ls

logout

Remove OAuth credentials for an MCP server.

Terminal window
treq mcp logout [name]

debug

Debug OAuth connection issues for an MCP server.

Terminal window
treq mcp debug <name>

models

List all available models from configured providers.

Terminal window
treq models [provider]

This command displays all models available across your configured providers in the format provider/model.

This is useful for figuring out the exact model name to use in your config.

You can optionally pass a provider ID to filter models by that provider.

Terminal window
treq models anthropic

Flags

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

Use the --refresh flag to update the cached model list. This is useful when new models have been added to a provider and you want to see them in t-req.

Terminal window
treq models --refresh

run

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

Terminal window
treq run [message..]

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

Terminal window
treq run Explain the use of context in Go

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

Terminal window
# Start a headless server in one terminal
treq serve
# In another terminal, run commands that attach to it
treq 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
--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 treq server (e.g., http://localhost:4096)
--portPort for the local server (defaults to random port)

serve

Start a headless t-req server for API access. Check out the server docs for the full HTTP interface.

Terminal window
treq serve

This starts an HTTP server that provides API access to treq functionality without the TUI interface.

Flags

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

session

Manage t-req sessions.

Terminal window
treq session [command]

list

List all t-req sessions.

Terminal window
treq 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 t-req sessions.

Terminal window
treq 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
treq 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 t-req share URL.

Terminal window
treq import <file>

You can import from a local file or an t-req share URL.

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

web

Start a headless t-req server with a web interface.

Terminal window
treq web

This starts an HTTP server and opens a web browser to access t-req through a web interface.

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
treq 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 t-req and remove all related files.

Terminal window
treq 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 treq to the latest version or a specific version.

Terminal window
treq upgrade [target]

To upgrade to the latest version.

Terminal window
treq upgrade

To upgrade to a specific version.

Terminal window
treq upgrade v0.1.48

Flags

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

Global Flags

The treq 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

t-req can be configured using environment variables.

VariableTypeDescription
OPENCODE_AUTO_SHAREbooleanAutomatically share sessions
OPENCODE_GIT_BASH_PATHstringPath to Git Bash executable on Windows
OPENCODE_CONFIGstringPath to config file
OPENCODE_CONFIG_DIRstringPath to config directory
OPENCODE_CONFIG_CONTENTstringInline json config content
OPENCODE_DISABLE_AUTOUPDATEbooleanDisable automatic update checks
OPENCODE_DISABLE_PRUNEbooleanDisable pruning of old data
OPENCODE_DISABLE_TERMINAL_TITLEbooleanDisable automatic terminal title updates
OPENCODE_PERMISSIONstringInlined json permissions config
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanDisable default plugins
OPENCODE_DISABLE_LSP_DOWNLOADbooleanDisable automatic LSP server downloads
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleanEnable experimental models
OPENCODE_DISABLE_AUTOCOMPACTbooleanDisable automatic context compaction
OPENCODE_CLIENTstringClient identifier (defaults to cli)
OPENCODE_ENABLE_EXAbooleanEnable Exa web search tools

Experimental

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

VariableTypeDescription
OPENCODE_EXPERIMENTALbooleanEnable all experimental features
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanEnable icon discovery
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDisable copy on select in TUI
OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTHnumberMax output length for bash commands
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDefault timeout for bash commands in ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMax output tokens for LLM responses
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanEnable file watcher for entire dir
OPENCODE_EXPERIMENTAL_OXFMTbooleanEnable oxfmt formatter
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleanEnable experimental LSP tool