fx-devkit
One manifest for your repositories, tools, and coding agents.
Documentation · Quick start ·
Changelog · Contributing
English · 日本語 ·
简体中文 ·
繁體中文
fx prepares a multi-repository workspace from your team's versioned manifest.
It synchronizes checkouts, prepares companion tools and agent resources, and
locates services, owners and environment-specific diagnostics. Each repository
keeps its own history, branches, dependencies and build system.
- Preview writes with
--dry-run; sync preserves dirty and diverged checkouts.
- Share repository, tool and environment definitions while keeping personal
selections and credentials local.
- Use human output interactively or JSON with explicit status and recovery steps.
- Keep authentication and service APIs in the companion tools you already use.
A compatible
bitbucket-cli also supplies HTTPS Git authentication for init and sync,
including manifests with SSH URLs, without giving tokens to fx.
WeCom smart-bot workers can use the wecom-chat-cli companion; see the
worker binding and isolation requirements.
Requirements
Use Node.js 22 or newer, Git and npm. Bun is also supported as an alternative
runtime. macOS and Linux are supported; native Windows execution and agent host
activation remain unverified. See platform support.
The documentation follows current source. See the version history
for release changes; an installed package's help and bundled Skill describe
that executable.
You also need a team manifest. Use an existing source or
create one from your checkouts.
Install
The internal package is @fx/devkit; the public package is @angelmsger/fx on
npmjs. Both provide fx.
For the internal package, use your team's existing npm configuration. If its
@fx scope is not configured yet, sign in once with the team Registry URL.
The URL below is fictional:
npm login --registry=https://npm.example.com/ --scope=@fx
npm install -g @fx/devkit
fx --version
Install from npmjs:
npm install -g @angelmsger/fx --registry=https://registry.npmjs.org/ --@angelmsger:registry=https://registry.npmjs.org/
fx --version
See the installation guide for source installations,
PowerShell commands and Registry routing. For updates, use
Support and updates.
Quick start
You need two things: the manifest source supplied by your team and a directory
for the workspace. Preview the plan, then apply it:
fx init ./work --from <manifest-repository> --dry-run
fx init ./work --from <manifest-repository>
The quick start explains what init prepares,
how to continue after a sign-in or approval, and how to
limit the first download.
Everyday commands
| Task | Command |
|---|
| Find managed workspaces | fx workspace list / fx workspace show <name> |
| Inspect checkouts | fx status |
| Preview updates | fx sync --dry-run |
| Replace a repository selection | fx repo select <name...> / fx repo select --all |
| Select repositories | fx repo pick <name...> / fx repo unpick <name...> |
| Select environments | fx env pick <name...> / fx env unpick <name...> |
| Find a person by business area | fx member show <query> --area <area> |
| Find a service | fx where <repo> --env <environment> |
| List capabilities | fx can |
| Check a capability | fx can <capability> --env <environment> |
| Refresh guides and Skills | fx sync --only docs,skills |
| Check what is ready to release | fx release check |
| Inspect version history | fx repo version <repo> |
Use repo list, env list, agent list and tool list to discover valid names.
Use repo select and env select to choose an exact set, --all to follow the
team's full set including future additions, or --none to select nothing.
pick/unpick add or remove individual names. First-time setup can limit cloning
with fx init ./work --from <manifest-repository> --repos example-api,example-web --dry-run.
where prints coordinates and commands; it does not execute those commands.
release check shows what each repository would release and whether it is ready; it
never publishes or deploys.
The CLI reference and fx <command> --help own exact syntax.
For coding agents
Run fx self info --format json, then read SKILL.md in its bundled_skill
directory, or run fx skill show. Global Skill installation is optional. Start
sessions at the registered workspace root to use team guidance.
The user guide explains structured
results, completion verdicts and recovery; the bundled
Skill routes each task to its reference.
Configuration
fx config list shows settings and their sources. fx config get <key> --explain
shows the effective value. Explicit flags override environment, file and defaults.
Agent selection applies across workspaces in the same FX_HOME:
fx config set agents codex selects Codex; fx config set agents '' selects none.
fx config unset agents restores detection when FX_AGENTS is also unset.
FX_HOME relocates fx state, but not global Skills or companion credentials.
For service presets, tool installation history, host resources and shell
completion, see the user guide. For information sharing and
local data, see Your data and credentials.
Contributing and support
CONTRIBUTING.md covers local setup, checks and pull requests.
Architecture describes current contracts;
Roadmap lists possible extensions.
Report reproducible problems through support.
Include the version, operating system, command and a redacted reproduction.
Report vulnerabilities privately using SECURITY.md.
Licensed under the Apache License, Version 2.0.
