Install

The CLI is published as @freecodexyz/cli on npm and exposes the fcf binary.

Global install (recommended for local use)

npm install --global @freecodexyz/cli@alpha

Verify:

fcf --help

The CLI is currently published under the alpha dist-tag. Always pin to @alpha (or to an explicit version) until a stable tag is published.

One-off use without install

npx --yes -p @freecodexyz/cli@alpha -- fcf --help

This is what the generated GitHub Actions workflow uses, via npm exec:

- name: Register repository
  env:
    PRIVATE_KEY: ${{ secrets.FCF_PRIVATE_KEY }}
    RPC_URL: ${{ vars.FCF_RPC_URL }}
    FCF_CONTRACT: ${{ vars.FCF_CONTRACT }}
  run: |
    npm exec --yes --package=@freecodexyz/cli@alpha -- fcf register \
      --contract "$FCF_CONTRACT"

From source

For development against unreleased changes:

git clone https://github.com/freecodexyz/fcf.git
cd fcf/cli
corepack enable
pnpm install --frozen-lockfile
pnpm dev -- --help

pnpm dev runs the CLI through tsx against the TypeScript source. To produce a built binary:

pnpm build
node dist/index.js --help

Use Node 24 to match the CI environment.

Requirements

• Node.js 20+ for general use.
• Node.js 24 for development and to match CI exactly.
• A POSIX-like shell for the install commands above.

Continue

• CLI Overview, what the CLI does.
• Getting Started, what to do once it's installed.