Fixie CLI Reference
This page provides documentation for the Fixie command line tool.
fixie
Command-line interface to the Fixie platform.
Usage:
fixie [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
agent
Agent-related commands.
Usage:
fixie agent [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
delete
Delete an agent.
Usage:
fixie agent delete [OPTIONS] HANDLE
Options:
--help Show this message and exit.
deploy
Deploy the current agent.
Usage:
fixie agent deploy [OPTIONS] [PATH]
Options:
--metadata-only (No longer supported.)
--public Make the agent public.
--validate / --no-validate (default enabled) Validate that the agent loads
in a local venv before deploying.
--current / --not-current (default enabled) Change the current revision to
the deployed revision.
--metadata TEXT... Additional metadata to associate with the
revision.
--reindex / --no-reindex Force any corpora to be reindexed.
--help Show this message and exit.
init
Creates an agent.yaml file.
Usage:
fixie agent init [OPTIONS] [PATH]
Options:
--handle TEXT
--description TEXT
--entry-point TEXT
--more-info-url TEXT
--requirement TEXT Additional requirements for requirements.txt. Can be
specified multiple times.
--help Show this message and exit.
list
List agents.
Usage:
fixie agent list [OPTIONS]
Options:
--verbose Enable verbose output.
--help Show this message and exit.
publish
Make the current agent public.
Usage:
fixie agent publish [OPTIONS] [PATH]
Options:
--help Show this message and exit.
revisions
Revisions-related commands.
Usage:
fixie agent revisions [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
delete
Deletes a revision of an agent.
Usage:
fixie agent revisions delete [OPTIONS] [PATH]
Options:
--id TEXT The revision ID to delete. [required]
--force / -f Delete the revision even if it is the current one.
--help Show this message and exit.
list
Lists the revisions associated with an agent.
Usage:
fixie agent revisions list [OPTIONS] [PATH]
Options:
--json
--help Show this message and exit.
set-current
Sets the current (active) revision of an agent.
Usage:
fixie agent revisions set-current [OPTIONS] [PATH]
Options:
--id TEXT The revision ID to make current. [required]
--help Show this message and exit.
serve
Serve the current agent locally via a publicly-accessible URL.
Usage:
fixie agent serve [OPTIONS] [PATH]
Options:
--host TEXT
--port INTEGER
--tunnel / --no-tunnel (default enabled) Create a tunnel using
localhost.run.
--reload / --no-reload (default enabled) Reload automatically.
--venv / --no-venv Run from virtual environment
--help Show this message and exit.
show
Show an agent.
Usage:
fixie agent show [OPTIONS] AGENT_ID
Options:
--help Show this message and exit.
unpublish
Make the current agent not public.
Usage:
fixie agent unpublish [OPTIONS] [PATH]
Options:
--help Show this message and exit.
auth
Authorizes fixie to access Fixie platform.
Usage:
fixie auth [OPTIONS]
Options:
--force Forces authentication, even if the user is authenticated.
--help Show this message and exit.
deploy
Deploy the current agent.
Usage:
fixie deploy [OPTIONS] [PATH]
Options:
--metadata-only (No longer supported.)
--public Make the agent public.
--validate / --no-validate (default enabled) Validate that the agent loads
in a local venv before deploying.
--current / --not-current (default enabled) Change the current revision to
the deployed revision.
--metadata TEXT... Additional metadata to associate with the
revision.
--reindex / --no-reindex Force any corpora to be reindexed.
--help Show this message and exit.
init
Creates an agent.yaml file.
Usage:
fixie init [OPTIONS] [PATH]
Options:
--handle TEXT
--description TEXT
--entry-point TEXT
--more-info-url TEXT
--requirement TEXT Additional requirements for requirements.txt. Can be
specified multiple times.
--help Show this message and exit.
new
Creates a new session and opens it.
Usage:
fixie new [OPTIONS] [MESSAGE]
Options:
--web Open the session in the web interface.
-a, --agent TEXT A specific agent to talk to. If unset, `fixie` is used.
-v, --verbose Enable verbose output.
--help Show this message and exit.
publish
Make the current agent public.
Usage:
fixie publish [OPTIONS] [PATH]
Options:
--help Show this message and exit.
query
Runs a single query and exit.
Usage:
fixie query [OPTIONS] MESSAGE
Options:
--web Open the session in the web interface.
--keep Do not delete the session after use.
-v, --verbose Enable verbose output.
-a, --agent TEXT A specific agent to talk to. If unset, `fixie` is used.
--help Show this message and exit.
serve
Serve the current agent locally via a publicly-accessible URL.
Usage:
fixie serve [OPTIONS] [PATH]
Options:
--host TEXT
--port INTEGER
--tunnel / --no-tunnel (default enabled) Create a tunnel using
localhost.run.
--reload / --no-reload (default enabled) Reload automatically.
--venv / --no-venv Run from virtual environment
--help Show this message and exit.
session
Session-related commands.
Usage:
fixie session [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
list
Lists sessions.
Usage:
fixie session list [OPTIONS]
Options:
--help Show this message and exit.
new
Creates a new session and opens it.
Usage:
fixie session new [OPTIONS] [MESSAGE]
Options:
--web Open the session in the web interface.
-a, --agent TEXT A specific agent to talk to. If unset, `fixie` is used.
-v, --verbose Enable verbose output.
--help Show this message and exit.
open
Opens a session.
Usage:
fixie session open [OPTIONS] SESSION_ID [MESSAGE]
Options:
--web Open the session in the web interface.
-a, --agent TEXT A specific agent to talk to. If unset, `fixie` is used.
-v, --verbose Enable verbose output.
--help Show this message and exit.
query
Runs a single query and exit.
Usage:
fixie session query [OPTIONS] MESSAGE
Options:
--web Open the session in the web interface.
--keep Do not delete the session after use.
-v, --verbose Enable verbose output.
-a, --agent TEXT A specific agent to talk to. If unset, `fixie` is used.
--help Show this message and exit.
unpublish
Make the current agent not public.
Usage:
fixie unpublish [OPTIONS] [PATH]
Options:
--help Show this message and exit.
user
Displays information on the authenticated user.
Usage:
fixie user [OPTIONS]
Options:
--help Show this message and exit.