CLI
t-req CLI options and commands.
The t-req CLI by default starts the TUI when run without any arguments.
treqBut it also accepts commands as documented on this page. This allows you to interact with t-req programmatically.
treq run "Explain how closures work in JavaScript"tui
Start the t-req terminal user interface.
treq [project]Flags
| Flag | Short | Description |
|---|---|---|
--continue | -c | Continue the last session |
--session | -s | Session ID to continue |
--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 t-req CLI also has the following commands.
agent
Manage agents for t-req.
treq agent [command]attach
Attach a terminal to an already running t-req backend server started via serve or web commands.
treq attach [url]This allows using the TUI with a remote t-req backend. For example:
# Start the backend server for web/mobile accesstreq web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendtreq 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.
treq agent createThis command will guide you through creating a new agent with a custom system prompt and tool configuration.
list
List all available agents.
treq agent listauth
Command to manage credentials and login for providers.
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.
treq auth loginWhen 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.
treq auth listOr the short version.
treq auth lslogout
Logs you out of a provider by clearing it from the credentials file.
treq auth logoutgithub
Manage the GitHub agent for repository automation.
treq github [command]install
Install the GitHub agent in your repository.
treq 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.
treq github runFlags
| Flag | Description |
|---|---|
--event | GitHub mock event to run the agent for |
--token | GitHub personal access token |
mcp
Manage Model Context Protocol servers.
treq mcp [command]add
Add an MCP server to your configuration.
treq 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.
treq mcp listOr use the short version.
treq mcp lsauth
Authenticate with an OAuth-enabled MCP server.
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.
treq mcp auth listOr use the short version.
treq mcp auth lslogout
Remove OAuth credentials for an MCP server.
treq mcp logout [name]debug
Debug OAuth connection issues for an MCP server.
treq mcp debug <name>models
List all available models from configured providers.
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.
treq models anthropicFlags
| Flag | Description |
|---|---|
--refresh | Refresh the models cache from models.dev |
--verbose | Use 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.
treq models --refreshrun
Run treq in non-interactive mode by passing a prompt directly.
treq run [message..]This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.
treq run Explain the use of context in GoYou can also attach to a running treq serve instance to avoid MCP server cold boot times on every run:
# Start a headless server in one terminaltreq serve
# In another terminal, run commands that attach to ittreq 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 |
--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 treq server (e.g., http://localhost:4096) | |
--port | Port 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.
treq serveThis starts an HTTP server that provides API access to treq functionality without the TUI interface.
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 t-req sessions.
treq session [command]list
List all t-req sessions.
treq 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 t-req sessions.
treq 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.
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.
treq import <file>You can import from a local file or an t-req share URL.
treq import session.jsontreq import https://opncd.ai/s/abc123web
Start a headless t-req server with a web interface.
treq webThis starts an HTTP server and opens a web browser to access t-req through a web interface.
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.
treq 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 t-req and remove all related files.
treq 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 treq to the latest version or a specific version.
treq upgrade [target]To upgrade to the latest version.
treq upgradeTo upgrade to a specific version.
treq upgrade v0.1.48Flags
| Flag | Short | Description |
|---|---|---|
--method | -m | The installation method that was used; curl, npm, pnpm, bun, brew |
Global Flags
The treq 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
t-req can be configured using environment variables.
| Variable | Type | Description |
|---|---|---|
OPENCODE_AUTO_SHARE | boolean | Automatically share sessions |
OPENCODE_GIT_BASH_PATH | string | Path to Git Bash executable on Windows |
OPENCODE_CONFIG | string | Path to config file |
OPENCODE_CONFIG_DIR | string | Path to config directory |
OPENCODE_CONFIG_CONTENT | string | Inline json config content |
OPENCODE_DISABLE_AUTOUPDATE | boolean | Disable automatic update checks |
OPENCODE_DISABLE_PRUNE | boolean | Disable pruning of old data |
OPENCODE_DISABLE_TERMINAL_TITLE | boolean | Disable automatic terminal title updates |
OPENCODE_PERMISSION | string | Inlined json permissions config |
OPENCODE_DISABLE_DEFAULT_PLUGINS | boolean | Disable default plugins |
OPENCODE_DISABLE_LSP_DOWNLOAD | boolean | Disable automatic LSP server downloads |
OPENCODE_ENABLE_EXPERIMENTAL_MODELS | boolean | Enable experimental models |
OPENCODE_DISABLE_AUTOCOMPACT | boolean | Disable automatic context compaction |
OPENCODE_CLIENT | string | Client identifier (defaults to cli) |
OPENCODE_ENABLE_EXA | boolean | Enable Exa web search tools |
Experimental
These environment variables enable experimental features that may change or be removed.
| Variable | Type | Description |
|---|---|---|
OPENCODE_EXPERIMENTAL | boolean | Enable all experimental features |
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY | boolean | Enable icon discovery |
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Disable copy on select in TUI |
OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTH | number | Max output length for bash commands |
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | Default timeout for bash commands in ms |
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | Max output tokens for LLM responses |
OPENCODE_EXPERIMENTAL_FILEWATCHER | boolean | Enable file watcher for entire dir |
OPENCODE_EXPERIMENTAL_OXFMT | boolean | Enable oxfmt formatter |
OPENCODE_EXPERIMENTAL_LSP_TOOL | boolean | Enable experimental LSP tool |