CLI

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

fring

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

fring run "Explain how closures work in JavaScript"

---

tui

Start the Fring terminal user interface.

fring [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
--mdns		Enable mDNS discovery
--mdns-domain		Custom mDNS domain name
--cors		Additional browser origin(s) to allow CORS

---

Commands

The Fring CLI also has the following commands.

---

agent

Manage agents for Fring.

fring agent [command]

---

attach

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

fring attach [url]

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

# Start the backend server for web/mobile access
fring web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
fring attach http://10.20.30.40:4096

Flags

Flag	Short	Description
--dir		Working directory to start TUI in
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--fork		Fork the session when continuing (use with --continue or --session)
--password	-p	Basic auth password (defaults to OPENCODE_SERVER_PASSWORD)
--username	-u	Basic auth username (defaults to OPENCODE_SERVER_USERNAME or fring)

---

create

Create a new agent with custom configuration.

fring agent create

This command will guide you through creating a new agent with a custom system prompt and permission configuration. Anything you don’t allow is denied in the generated agent’s frontmatter.

Flags

Flag	Short	Description
--path		Directory to write the agent file to (defaults to global or .opencode/agent based on the prompt)
--description		What the agent should do
--mode		Agent mode: all, primary, or subagent
--permissions		Comma-separated list of permissions to allow (default: all). Available: bash, read, edit, glob, grep, webfetch, task, todowrite, websearch, lsp, skill. Anything omitted is denied. Alias: --tools
--model	-m	Model to use, in provider/model format

Passing all of --path, --description, --mode, and --permissions runs the command non-interactively.

---

list

List all available agents.

fring agent list

---

login

Sign in to Fring. A device-code flow: it prints a URL and a short code, opens your browser, and completes once you approve it there. Credentials are written to ~/.local/share/fring/auth.json.

fring login

---

logout

Sign out and clear the stored credentials.

fring logout

---

console

Manage the signed-in account.

fring console [command]

Command	Description
login	Log in to the console
logout	Log out from the console
status	Show account, plan and usage
switch	Switch active workspace
orgs	List workspaces
open	Open the active console account in a browser

---

github

Manage the GitHub agent for repository automation.

fring github [command]

---

install

Install the GitHub agent in your repository.

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

fring github run

Flags

Flag	Description
--event	GitHub mock event to run the agent for
--token	GitHub personal access token

---

mcp

Manage Model Context Protocol servers.

fring mcp [command]

---

add

Add an MCP server to your configuration.

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

fring mcp list

Or use the short version.

fring mcp ls

---

auth

Authenticate with an OAuth-enabled MCP server.

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

fring mcp auth list

Or use the short version.

fring mcp auth ls

---

logout

Remove OAuth credentials for an MCP server.

fring mcp logout [name]

---

debug

Debug OAuth connection issues for an MCP server.

fring mcp debug <name>

---

models

List all available models from configured providers.

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

fring models anthropic

Flags

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

fring models --refresh

---

run

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

fring run [message..]

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

fring run Explain the use of context in Go

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

# Start a headless server in one terminal
fring serve

# In another terminal, run commands that attach to it
fring 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 fring server (e.g., http://localhost:4096)
--password	-p	Basic auth password (defaults to OPENCODE_SERVER_PASSWORD)
--username	-u	Basic auth username (defaults to OPENCODE_SERVER_USERNAME or fring)
--dir		Directory to run in, or path on the remote server when attaching
--port		Port for the local server (defaults to random port)
--variant		Model variant (provider-specific reasoning effort)
--thinking		Show thinking blocks
--dangerously-skip-permissions		Auto-approve permissions that are not explicitly denied (dangerous!)

---

serve

Start a headless Fring server for API access. Check out the server docs for the full HTTP interface.

fring serve

This starts an HTTP server that provides API access to Fring functionality without the TUI interface. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to fring).

Flags

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

session

Manage Fring sessions.

fring session [command]

---

list

List all Fring sessions.

fring session list

Flags

Flag	Short	Description
--max-count	-n	Limit to N most recent sessions
--format		Output format: table or json (table)

---

delete

Delete a Fring session.

fring session delete <sessionID>

---

stats

Show token usage and cost statistics for your Fring sessions.

fring stats

Flags

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.

fring export [sessionID]

If you don’t provide a session ID, you’ll be prompted to select from available sessions.

Flags

Flag	Description
--sanitize	Redact sensitive transcript/file data

---

import

Import session data from a JSON file or Fring share URL.

fring import <file>

You can import from a local file or a Fring share URL.

fring import session.json
fring import https://opncd.ai/s/abc123

---

web

Start a headless Fring server with a web interface.

fring web

This starts an HTTP server and opens a web browser to access Fring through a web interface. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to fring).

Flags

Flag	Description
--port	Port to listen on
--hostname	Hostname to listen on
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

acp

Start an ACP (Agent Client Protocol) server.

fring acp

This 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
--mdns	Enable mDNS discovery
--mdns-domain	Custom mDNS domain name
--cors	Additional browser origin(s) to allow CORS

---

plugin

Install a plugin and update your config.

fring plugin <module>

Or use the alias.

fring plug <module>

Flags

Flag	Short	Description
--global	-g	Install in global config
--force	-f	Replace existing plugin version

---

pr

Fetch and checkout a GitHub PR branch, then run Fring.

fring pr <number>

---

db

Database tools.

fring db [query]

Flags

Flag	Description
--format	Output format: json or tsv

---

path

Print the database path.

fring db path

---

debug

Debugging and troubleshooting tools.

fring debug [command]

---

uninstall

Uninstall Fring and remove all related files.

fring uninstall

Flags

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

fring upgrade [target]

To upgrade to the latest version.

fring upgrade

To upgrade to a specific version.

fring upgrade v0.1.48

Flags

Flag	Short	Description
--method	-m	The installation method that was used; curl, npm, pnpm, bun, brew

---

Global Flags

The Fring 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)
--pure		Run without external plugins

---

Environment variables

Fring 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_TUI_CONFIG	string	Path to TUI 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_DISABLE_CLAUDE_CODE	boolean	Disable reading from .claude (prompt + skills)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT	boolean	Disable reading ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS	boolean	Disable loading .claude/skills
OPENCODE_DISABLE_MODELS_FETCH	boolean	Disable fetching models from remote sources
OPENCODE_DISABLE_MOUSE	boolean	Disable mouse capture in the TUI
OPENCODE_FAKE_VCS	string	Fake VCS provider for testing purposes
OPENCODE_CLIENT	string	Client identifier (defaults to cli)
OPENCODE_ENABLE_EXA	boolean	Enable Exa web search tools
OPENCODE_SERVER_PASSWORD	string	Enable basic auth for serve/web
OPENCODE_SERVER_USERNAME	string	Override basic auth username (default fring)
OPENCODE_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
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_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
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER	boolean	Disable file watcher
OPENCODE_EXPERIMENTAL_EXA	boolean	Enable experimental Exa features
OPENCODE_EXPERIMENTAL_LSP_TY	boolean	Enable TY LSP for python files
OPENCODE_EXPERIMENTAL_MARKDOWN	boolean	Enable experimental markdown features
OPENCODE_EXPERIMENTAL_PLAN_MODE	boolean	Enable plan mode