FX-DEVKIT / DOCUMENTATION

CLI commands

Commands, arguments and flags generated from the CLI.

v0.20.0 · PUBLIC PREVIEW

Command syntax for the current source (package version 0.20.0). See the version history for changes between releases. Use fx <command> --help for the exact syntax supported by your executable.

Everyday

Command What it answers
fx init Prepare a workspace from a manifest, set up companion tools without one, or continue unfinished preparation
fx sync Bring the workspace up to date: clone what is missing, fast-forward what is clean, never touch work in progress
fx login Prepare tool access for the selected workspace: authentication, configuration and permission checks
fx doctor Check repositories, tools, login state, agent Skills, the manifest and whether fx or the manifest is behind, in one pass
fx status Show every tracked repository: branch, cleanliness, position against upstream
fx can Whether a capability or tool can be used right now, its checked executable, and how to recover
fx where Locate repository coordinates; optionally probe or record their existence
fx release check Show what each repository would release and check it: dependencies, branches, builds and unresolved errors. Read-only
fx completion Print a shell completion script for bash, zsh, fish or PowerShell

Topics

Topic Commands
fx agent Coding agents: discover, select globally, inspect workspace Skills
fx config Personal settings in ~/.fx/config.yaml, and carrying them to another machine
fx env Environments: list, show, pick
fx hook Workspace lifecycle hooks: inspect, enable and disable
fx manifest Shared manifest: validate, explain, edit repository fields and record probe evidence
fx mcp Workspace MCP resources, projections and readiness
fx member People: list them, show who a name refers to
fx release Release checklist: what each repository would release, and whether it is ready
fx repo Repositories: list, show, pick, register, fork, open
fx self The fx tool itself: info, update
fx skill Bundled fx companion Skill: install, inspect and remove without a workspace
fx source Source contributions: validate selected files and propose a pull request
fx tool Companion tools: definitions, installation, inventory and history
fx workspace Workspace identities: discover, inspect, relocate, rebind and unregister

Global flags

Every command accepts these.

Flag Description
--allow-writes override read-only posture (read_only / FX_READ_ONLY) for this invocation (default: false)
--command-shell shell for generated commands (does not change execution) (one of: auto, posix, powershell, cmd; env: FX_COMMAND_SHELL)
--details include all report details; fact queries already return their full result (default: false)
--fields comma-separated dot paths to keep in the output, e.g. name,obs.svc
--format output format; agents use json (one of: human, json, ndjson; env: FX_FORMAT)
--no-header omit column headings from human list output (default: false)
--no-input never prompt; fail with a structured error instead (default: false)
--quiet suppress notices on stderr; errors are still reported (default: false)
--verbose diagnostic detail on stderr (default: false)
--workspace select a registered name or root directory; otherwise use cwd then default_workspace; global commands still cover this FX_HOME (env: FX_WORKSPACE)
--yes assume yes for confirmations, including trust for new manifest commands (default: false)

fx init

Prepare a workspace from a manifest, set up companion tools without one, or continue unfinished preparation

Provide a directory and source. fx prepares the selected repositories, local tools and Agent guides, then verifies the result. Only local prepare steps execute automatically, even with --yes; personal sign-in is a handoff. Read preparation.next for the next decision. After completing them, use init --resume --workspace <name>. Existing user files and completed work are preserved.

Without a directory and source, init sets up companion tools on this machine instead: the ones --tools names, or the ones a person picks from the catalog. fx installs the missing ones and their Skills, checks each sign-in, and on a terminal offers to start a tool's own setup, which asks for the service and the person's credentials.

Arguments:

Argument Required Description
dir no directory to prepare; omitted with --resume

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--from git URL or checkout of the manifest repository, a directory holding manifest/, or - for workspace YAML / a source bundle
--jobs independent checks handled at the same time (default: 4)
--name registration name; default: an available name derived from the directory
--no-repos select no shared repositories; still prepares declared tools and agent resources (exclusive with: --repos)
--repos comma-separated shared repositories to select before the first clone; replaces existing shared selection when provided (exclusive with: --no-repos)
--resume continue a registered workspace without reimporting its source (exclusive with: --from, --name, --repos, --no-repos, --tools)
--tools without a manifest: comma-separated catalog tools to set up on this machine, or all; a terminal asks when omitted (exclusive with: --from, --name, --repos, --no-repos)

Examples:

bash
fx init ~/Workspaces/fx --from ssh://git@git.example.com/team/workspace-manifest.git
fx init ./ws --from ./manifest --repos api --dry-run
fx init --resume --workspace ws
cat workspace.yaml | fx init ./ws --from -
fx init   # pick companion tools to set up on this machine
fx init --tools bitbucket-cli,jira-cli --dry-run

fx sync

Bring the workspace up to date: clone what is missing, fast-forward what is clean, never touch work in progress

Explicit sync also prepares declared public service settings. It never acquires or distributes personal credentials.

The result may be partial even with exit zero. Inspect summary.failed, summary.unreadable, stages and each failed item's structured failure before retrying.

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--jobs independent checks handled at the same time (default: 4)
--only run selected stages (repeatable or comma-separated) (repeatable; one of: repos, services, setup, docs, go, skills, hooks, mcp, tools)
--refresh-manifest / --no-refresh-manifest pull the manifest repository first; --no-refresh-manifest skips it (default: true)

Examples:

bash
fx sync
fx sync --dry-run --format json

fx login

Prepare tool access for the selected workspace: authentication, configuration and permission checks

Arguments:

Argument Required Description
tool no only these tools (variadic)

Flags:

Flag Description
--dry-run check current state and preview each unfinished action (default: false; exclusive with: --list)
--env only these environments (repeatable or comma-separated) (repeatable)
--list print the static plan without checking current state (default: false; exclusive with: --dry-run, --skip-manual)
--skip-manual only steps fx can run itself (default: false; exclusive with: --list)

Examples:

bash
fx login --list
fx login
fx login kubectl --env test
fx login <tool> --dry-run --no-input --format json
fx login --no-input --format json   # inspect pending setup; resume after verification

fx doctor

Check repositories, tools, login state, agent Skills, the manifest and whether fx or the manifest is behind, in one pass

Flags:

Flag Description
--dry-run print the fix plan instead of applying it (requires: --fix)
--env only these environments (provider tool and login checks) (repeatable or comma-separated) (repeatable)
--fix apply the fixes fx can make itself
--tool limit checks and fixes to these tools and their setup; omit for the whole workspace (repeatable or comma-separated) (repeatable)

Examples:

bash
fx doctor
fx doctor --env test --format json
fx doctor --fix   # run-type login steps and Skill links; nothing a person must do

fx status

Show every tracked repository: branch, cleanliness, position against upstream

Flags:

Flag Description
--dirty list repositories with tracked changes or untracked files (ignored files excluded) (default: false)
--dry-run print the fetch plan instead of applying it (requires: --fetch)
--fetch fetch upstream first (default: report local state only)
--jobs independent checks handled at the same time (default: 4)

Examples:

bash
fx status
fx status --fetch --dirty

fx can

Whether a capability or tool can be used right now, its checked executable, and how to recover

Without a target, list every capability a manifest binds and what serves it in this workspace. The list reads bindings only; it does not check readiness.

Arguments:

Argument Required Description
target no a capability (e.g. log-store) or a tool name; omit to list capabilities

Flags:

Flag Description
--agent the host for an mcp:<name> resource
--env the environment; required for environment-scoped capabilities

Examples:

bash
fx can --format json
fx can log-store --env test --format json
fx can cluster --env test
fx can bitbucket-cli

fx where

Locate repository coordinates; optionally probe or record their existence

Queries return a collection. --record writes verified evidence into source environments.yaml and returns a record with action (preview, recorded, unchanged or skipped) and written. --record --dry-run returns the write plan without probing or writing.

Arguments:

Argument Required Description
repo yes repository name

Flags:

Flag Description
--check / --no-check fill the ready column by running each provider's read-only verify (default: true)
--dry-run print the plan instead of applying it (default: false)
--env one environment; default: every environment in scope
--jobs independent checks handled at the same time (default: 4)
--platform one platform; default: all
--probe ask each platform, read-only, whether the coordinate exists; needs --env (default: false)
--record record definite probe evidence in source environments.yaml; needs --probe, --env and --platform (default: false)

Examples:

bash
fx where fx-example-api --env test --format json
fx where fx-example-api --env test --platform jenkins --probe --record --dry-run

fx release check

Show what each repository would release and check it: dependencies, branches, builds and unresolved errors. Read-only

Arguments:

Argument Required Description
repo no repository name(s); default: every one on the checklist (variadic)

Flags:

Flag Description
--baseline historical release baseline as repo=ref; repeat for multiple repositories (repeatable)
--env environment whose errors count; default: release.env
--from inclusive error-window start, ISO timestamp with timezone; requires --to and excludes --since
--history-limit maximum first-parent commits per version history (default: 100)
--jobs independent checks handled at the same time (default: 4)
--only only these checks (repeatable or comma-separated) (repeatable; one of: deps, merge, ci, errors)
--since how far back a new error counts; default: release.since
--tag only repositories carrying these tags (repeatable or comma-separated) (repeatable)
--to exclusive error-window end, ISO timestamp with timezone; requires --from
--version-history read the last version-field change at each pinned source head (default: false)
--version-path explicit version declaration as repo=path, including nested packages; repeatable (repeatable)

Examples:

bash
fx release check
fx release check --format json
fx release check fx-example-api --only merge

fx completion

Print a shell completion script for bash, zsh, fish or PowerShell

Arguments:

Argument Required Description
shell yes bash, zsh, fish, powershell

Examples:

bash
fx completion zsh > ~/.zfunc/_fx
fx completion bash > /usr/local/etc/bash_completion.d/fx
fx completion fish > ~/.config/fish/completions/fx.fish
fx completion powershell | Out-File -Encoding utf8 fx-completion.ps1

fx agent list

List the coding agents fx knows: detected on this machine, enabled, and where their Skills live

Examples:

bash
fx agent list

fx agent skills

List workspace team Skills and the bundled fx Skill for selected agents

Flags:

Flag Description
--agent only these agent ids (repeatable or comma-separated) (repeatable)

fx agent pick

Add coding agents to the shared selection across workspaces registered in this FX_HOME

Arguments:

Argument Required Description
id yes agent id(s), e.g. claude-code (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx agent pick claude-code codex

fx agent unpick

Deselect coding agents and reconcile owned resources across workspaces in this FX_HOME

Arguments:

Argument Required Description
id yes agent id(s), e.g. claude-code (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx agent unpick claude-code codex

fx config list

List every config key with its effective value and source

Examples:

bash
fx config list
fx config list --format json

fx config get

Show the effective value of a config key and where it comes from

Arguments:

Argument Required Description
key yes config key

Flags:

Flag Description
--explain show every layer, not only the winner (default: false)

Examples:

bash
fx config get format --explain

fx config set

Set a config key in ~/.fx/config.yaml

Arguments:

Argument Required Description
key yes config key
value yes new value; lists are comma-separated

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx config set format json
fx config set read_only true --dry-run

fx config unset

Remove a config key from ~/.fx/config.yaml

Arguments:

Argument Required Description
key yes config key

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx config unset format

fx config export

Write the personal state worth carrying to another machine: config.yaml and each workspace's local.yaml; never trust records, cache or credentials

Flags:

Flag Description
--dry-run print the file plan instead of writing it (requires: --out)
-o, --out file to write; default stdout (yaml)

Examples:

bash
fx config export -o me.yaml
fx config export --format json

fx config import

Apply a profile: named settings and personal layers win; workspace registrations merge by name, without relocating, rebinding or removing existing workspaces

Arguments:

Argument Required Description
file yes the profile file

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx config import me.yaml --dry-run
fx config import me.yaml

fx env list

List the environments, their platforms, and which ones this machine picked

Examples:

bash
fx env list --format json

fx env show

One environment's platform matrix: provider, variables, confidence, notes

Arguments:

Argument Required Description
name yes environment name

Examples:

bash
fx env show test

fx env select

Replace the shared environment selection; --all follows current and future declarations, --none selects none. This changes selection only; it does not perform login or setup.

Arguments:

Argument Required Description
name no names to select exclusively (variadic)

Flags:

Flag Description
--all follow all shared declarations, including future additions (exclusive with: --none)
--dry-run print the plan instead of applying it (default: false)
--none select no shared environments (exclusive with: --all)

Examples:

bash
fx env select dev
fx env select --all

fx env pick

Add shared environments to the current selection; already-all is unchanged. Use env select to replace it.

Arguments:

Argument Required Description
name yes environment name(s) (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx env pick dev test

fx env unpick

Drop environments from this machine's scope

Arguments:

Argument Required Description
name yes environment name(s) (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx env unpick selfhosted

fx hook list

Show workspace lifecycle capabilities, projections and recent automatic sync evidence

Examples:

bash
fx hook list --format json

fx hook enable

Enable and project lifecycle hooks for the selected agents in this workspace

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx hook enable --format json

fx hook disable

Disable workspace lifecycle hooks and remove only fx-managed entries

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx hook disable --format json

fx manifest validate

Check every manifest document and report each problem with its path

Flags:

Flag Description
--kind check one document only (one of: workspace, environments, tools, members, harness)
--strict treat unknown fields as errors (default: false)

Examples:

bash
fx manifest validate --strict --format json

fx manifest lint

Suggest improvements to a valid manifest; never fails

Examples:

bash
fx manifest lint

fx manifest explain

Describe a manifest field: type, whether it is required, what it means

Arguments:

Argument Required Description
path no field path, e.g. repos[].branch; omit for the document root

Flags:

Flag Description
--kind which document (default: "workspace"; one of: workspace, environments, tools, members, harness, local)

Examples:

bash
fx manifest explain repos[].obs.overrides
fx manifest explain --kind tools tools[].setup

fx manifest schema

Print the JSON Schema of a manifest document; always JSON, whatever --format says

Flags:

Flag Description
--kind which document (default: "workspace"; one of: workspace, environments, tools, members, harness, local)

Examples:

bash
fx manifest schema --kind tools > tools.schema.json

fx manifest providers

Show which provider fulfils each capability, and where the binding comes from

Examples:

bash
fx manifest providers

fx manifest repo-set

Set a scalar field or aka array of a repository in workspace.yaml, touching nothing else

Arguments:

Argument Required Description
repo yes repository name
field yes path, desc, branch, project, upstream or aka
value yes new scalar value, or a JSON/YAML string array for aka

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx manifest repo-set fx-example-api branch feature/x --dry-run
fx manifest repo-set fx-example-api desc "Backend monolith"
fx manifest repo-set fx-example-api aka '["backend", "app-builder"]' --dry-run

fx manifest record-probe

Probe a repository coordinate and record definite evidence in the selected workspace source manifest

Arguments:

Argument Required Description
repo yes repository name

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--env environment containing the coordinate (required)
--jobs independent checks handled at the same time (default: 4)
--platform platform containing the coordinate (required)

Examples:

bash
fx manifest record-probe example-api --env test --platform jenkins --dry-run

fx manifest render

Regenerate manifest-derived AGENTS.md regions: explicit workspace selection wins, otherwise use the source checkout near cwd

Flags:

Flag Description
--check write nothing; fail when the document is stale (default: false)
--dry-run print the plan instead of applying it (default: false)
-o, --out create or replace a fully rendered AGENTS.md at this path instead; nothing else is touched

Examples:

bash
fx manifest render
fx manifest render --check   # CI: exit 11 when stale
fx manifest render --out /tmp/AGENTS.draft.md

fx manifest import

Describe an existing directory of repositories as a manifest, printed or written with -o; the checkouts are never touched

Arguments:

Argument Required Description
dir yes the directory to describe

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
-o, --out write the manifest to this file instead of printing it

Examples:

bash
fx manifest import ~/Workspaces/fx
fx manifest import ~/Workspaces/fx --format json
fx manifest import ~/Workspaces/fx -o fx-workspace/manifest/workspace.yaml

fx mcp list

List workspace MCP resources, projections and readiness

Examples:

bash
fx mcp list --format json

fx mcp show

Show one MCP declaration, environment references and readiness

Arguments:

Argument Required Description
name yes declared MCP resource name

Examples:

bash
fx mcp show knowledge --format json

fx member list

List people by business scope, team, function and status

Flags:

Flag Description
--area business area id or group name
--as-of relationship validity date (YYYY-MM-DD, default today in UTC)
--function function on the same relationship
--scenario scenario id within --area
--status only this status: active, initialized, resigned, deactivated
--team team on the matching relationship

Examples:

bash
fx member list --area Platform

fx member show

Who a name refers to: by email, id, an account in any system, display name or git author name

Arguments:

Argument Required Description
query yes email, id, account handle, name or git name

Flags:

Flag Description
--area business area id or group name
--as-of relationship validity date (YYYY-MM-DD, default today in UTC)
--scenario scenario id within --area
--system resolve an account in this system only

Examples:

bash
fx member show alice
fx member show ou_alice --format json

fx member selectors

List exact area, scenario, team and function selectors without people

Flags:

Flag Description
--kind only this kind of selector (one of: area, scenario, team, function)

Examples:

bash
fx member selectors --kind scenario --format json

fx repo list

List the repositories of the workspace, picked or not

Flags:

Flag Description
--picked only the repositories picked here (default: false; exclusive with: --unpicked)
--project only repositories of this code-host project
--tag only repositories carrying this tag
--unpicked only repositories left unpicked (default: false; exclusive with: --picked)
--unreadable which the code host denies you (default: false)

Examples:

bash
fx repo list --tag backend
fx repo list --unreadable

fx repo show

Show one repository: resolved entry, disk state, code-host URLs and responsibility facts

Arguments:

Argument Required Description
name yes repository name

Flags:

Flag Description
--as-of relationship validity date in the current members document (YYYY-MM-DD, default today in UTC); not a historical snapshot

fx repo version

Read a pinned version declaration, its last field change and an optional historical baseline. Read-only

Arguments:

Argument Required Description
name yes known repository name

Flags:

Flag Description
--baseline historical release ref to resolve and compare with the pinned head
--history-limit maximum first-parent commits examined (default: 100)
--path repository-relative VERSION or package metadata path; supports nested packages
--ref branch, tag or commit; default: declared repository branch or remote default

fx repo select

Replace the shared repository selection; --all follows current and future declarations, --none selects none. Run fx sync afterward to prepare selected repositories; existing checkouts are preserved.

Arguments:

Argument Required Description
name no names to select exclusively (variadic)

Flags:

Flag Description
--all follow all shared declarations, including future additions (exclusive with: --none)
--dry-run print the plan instead of applying it (default: false)
--none select no shared repositories (exclusive with: --all)

Examples:

bash
fx repo select api web
fx repo select --all

fx repo pick

Add shared repositories to the current selection; already-all is unchanged. Use repo select to replace it.

Arguments:

Argument Required Description
name yes repository name(s) (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx repo pick fx-example-api fx-example-auth

fx repo unpick

Stop tracking shared repositories on this machine; nothing on disk changes

Arguments:

Argument Required Description
name yes repository name(s) (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx repo unpick fx-example-docs

fx repo add

Register a checkout that exists only on this machine

Arguments:

Argument Required Description
path yes directory of the checkout

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--upstream upstream URL; defaults to the checkout's upstream or origin remote

Examples:

bash
fx repo add ../scratch-x --upstream ssh://git@git.example.com/lab/scratch-x.git

fx repo remove

Unregister a machine-local repository; the directory is kept

Arguments:

Argument Required Description
name yes repository name

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

fx repo fork

Create your personal fork on the code host and point origin at it

Arguments:

Argument Required Description
name yes repository name

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

fx repo open

Print the code-host page of a repository, and open it when on a terminal

Arguments:

Argument Required Description
name yes repository name

fx self info

Where this fx is: version, runtime, personal directory, bundled assets, effective registry and its source, workspace

Examples:

bash
fx self info --format json

fx self update

Update fx using npm registry configuration; FX_REGISTRY is an optional override

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx self update --dry-run
fx self update --yes

fx skill install

Install or refresh the bundled fx companion Skill without a workspace

Flags:

Flag Description
--agent target agent ids (repeatable or comma-separated) (repeatable)
--dir explicit Skill parent directory; excludes --agent and --project
--dry-run print the plan instead of applying it (default: false)
--project use agent Skill directories in the current directory instead of the user home (default: false)

Examples:

bash
fx skill install
fx skill install --agent codex --project
fx skill install --dir ./skills --dry-run

fx skill path

Show companion Skill installation targets and their current state

Flags:

Flag Description
--agent target agent ids (repeatable or comma-separated) (repeatable)
--dir explicit Skill parent directory; excludes --agent and --project
--project use agent Skill directories in the current directory instead of the user home (default: false)

fx skill show

Print the bundled SKILL.md verbatim (raw text in every output format)

fx skill status

Report companion Skill installations and versions; host activation is unverified

Flags:

Flag Description
--agent target agent ids (repeatable or comma-separated) (repeatable)
--dir explicit Skill parent directory; excludes --agent and --project
--project use agent Skill directories in the current directory instead of the user home (default: false)

fx skill uninstall

Remove identified fx companion Skill copies after confirmation

Flags:

Flag Description
--agent target agent ids (repeatable or comma-separated) (repeatable)
--dir explicit Skill parent directory; excludes --agent and --project
--dry-run print the plan instead of applying it (default: false)
--project use agent Skill directories in the current directory instead of the user home (default: false)

fx skill update

Refresh installed copies of the bundled fx companion Skill that are older than this fx

Flags:

Flag Description
--agent target agent ids (repeatable or comma-separated) (repeatable)
--dir explicit Skill parent directory; excludes --agent and --project
--dry-run print the plan instead of applying it (default: false)
--project use agent Skill directories in the current directory instead of the user home (default: false)

Examples:

bash
fx skill update
fx skill update --project --dry-run

fx source push

Validate selected source files and contribute them through a personal-fork pull request

Creates a commit, pushes the contribution branch to the personal fork, and creates or resumes a pull request. --dry-run validates and returns a plan without committing, pushing or creating a PR.

Arguments:

Argument Required Description
paths no source-relative file or directory paths; prompted if omitted (variadic)

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--issue issue ID for the commit; prompted if omitted
--message single-line commit summary
--new start a separate contribution instead of reusing a pending PR (default: false)
--pr known PR ID or URL to associate after an uncertain creation
--title new PR title; prompted if omitted

Examples:

bash
fx source push manifest/environments.yaml --issue TASK-123 --title "Update verified coordinates" --dry-run

fx tool list

List the companion tools the workspace expects, and where each entry comes from

Flags:

Flag Description
--catalog include the tools fx knows that no binding or declaration selects

Examples:

bash
fx tool list
fx tool list --catalog   # also the tools fx knows but nothing here selects

fx tool history

Read recorded tool installation attempts and outcomes across this FX_HOME, including tools removed from the manifest

Arguments:

Argument Required Description
tool no filter by the recorded tool name

Examples:

bash
fx tool history
fx tool history bitbucket-cli --format json

fx tool inventory

Inspect known installed tools across this FX_HOME, their installation origin and workspace requirements

Examples:

bash
fx tool inventory --format json

fx tool show

Show one tool: its resolved entry, where each field comes from, who depends on it

Arguments:

Argument Required Description
tool yes tool name

Examples:

bash
fx tool show bitbucket-cli

fx tool install

Install companion tools with the package manager the manifest names

Arguments:

Argument Required Description
tool no tool name(s); required unless --all is given (variadic)

Flags:

Flag Description
--all every enabled tool that is missing (default: false)
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx tool install openobserve-cli
fx tool install --all --dry-run

fx tool update

Update companion tools to their latest published version

Arguments:

Argument Required Description
tool no tool name(s); required unless --all is given (variadic)

Flags:

Flag Description
--all every enabled tool in the selected toolchain (default: false)
--dry-run print the plan instead of applying it (default: false)

Examples:

bash
fx tool update bitbucket-cli

fx workspace list

List registered workspaces from any directory, including unavailable roots and manifests

fx workspace show

Show registered identity, selection provenance, source and readiness without requiring a healthy manifest

Arguments:

Argument Required Description
name no registered name; defaults to current workspace resolution

fx workspace unregister

Stop managing one workspace: retire owned project resources, archive personal metadata and preserve business checkouts and global tools

Arguments:

Argument Required Description
name yes registered workspace name

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

fx workspace relocate

Point a workspace identity at its moved directory, preserving personal selections and checkout files; run sync afterwards to regenerate owned resources

Arguments:

Argument Required Description
name yes registered workspace name
dir yes existing directory after moving the workspace

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)

fx workspace rebind

Replace a registered manifest source with a validated staged source, preserving identity and local selections and retaining the previous source as a backup

Arguments:

Argument Required Description
name yes registered workspace name

Flags:

Flag Description
--dry-run print the plan instead of applying it (default: false)
--from new manifest Git URL, directory or - for stdin (required)

Compatibility aliases

These names remain executable. Help and command-name completion prefer their canonical entries.

Alias Canonical command
fx hook inject fx hook enable
fx hook remove fx hook disable
fx skill list fx agent skills
fx tool installed fx tool inventory
fx manifest set fx manifest repo-set
fx release fx release check

fx hook inject

Alias of fx hook enable.

fx hook remove

Alias of fx hook disable.

fx skill list

Alias of fx agent skills.

fx tool installed

Alias of fx tool inventory.

fx manifest set

Alias of fx manifest repo-set.

fx release

Alias of fx release check.