These docs describe the target Fibric platform contract and proposed developer experience. Public Fibric CLI, API endpoints, and SDK packages are not yet available. All present-tense API, CLI, SDK, tenancy, security, retention, retry, and pricing language below is normative target language, not a statement that the surface is callable or commercially available today. Commands, package names, URLs, responses, limits, and timelines are reference examples unless a page explicitly identifies a deployed BearScope path.
Installation
This page specifies a proposed Fibric CLI workflow for connecting systems, deploying operators, attaching policies, and reading receipts. It is a non-runnable design reference: the public CLI, developer workspace, API-key flow, and general-purpose console described below are not available today. For the current boundary, start with the quickstart.
Requirements
The target CLI is designed for npm and Node.js. The table documents proposed requirements; it is not an installation checklist for an available package.
| Requirement | Minimum | Notes |
|---|---|---|
| Node.js | 20 or newer | Check with node --version. LTS releases are recommended. |
| npm | 10 or newer | Ships with Node 20. Check with npm --version. |
| A Fibric account | Managed onboarding only | No public developer account flow exists. app.fibric.io is the BearScope product sign-in, not a Fibric developer console. |
| An API key | Workspace-scoped | Proposed target behavior. A public Fibric API-key console is not available. |
| Operating system | macOS, Linux, or Windows via WSL | Proposed target support is macOS, Linux, and Windows through WSL 2. |
app.fibric.io is the live BearScope product, not the generalized Fibric console shown in this reference. Managed platform evaluations are scoped through onboarding.
Install the CLI
The following non-runnable command illustrates the proposed package and command shape.
npm install -g @fibric/cli
# confirm the binary is on your PATH
fibric --versionProjects that define operators or connectors in code also need the SDK as a local dependency. You do not need it to follow this page; fibric init adds it for you in the next section.
# per-project SDK, installed inside a project directory
npm install @fibric/sdkAuthenticate
The CLI supports two authentication modes. Use the browser flow on a development machine; use an API key in CI and other non-interactive environments.
Browser flow
fibric auth login opens your default browser, asks you to sign in to your Fibric account, and writes a short-lived credential to ~/.fibric/credentials. If your account has more than one workspace, the CLI prompts you to pick one; you can switch later with the FIBRIC_WORKSPACE variable or the --workspace flag on any command.
fibric auth loginAPI key for CI
In CI, set an API key in the environment instead. A key is scoped to one workspace and can be rotated from the console at any time. When FIBRIC_API_KEY is set, the CLI uses it and skips the credential file entirely.
export FIBRIC_API_KEY="sk_live_…"
export FIBRIC_WORKSPACE="acme-ops"| Variable | Required | Description |
|---|---|---|
FIBRIC_API_KEY |
In CI | Workspace-scoped API key from Settings → API keys. Takes precedence over browser-flow credentials when set. |
FIBRIC_WORKSPACE |
No | Workspace slug to target, for example acme-ops. Overrides the default chosen during fibric auth login. |
Store the key in your CI provider's secret store or a secrets manager, never in the repository. If a key leaks, rotate it from the console; the old key stops working immediately.
Initialize a workspace project
fibric init scaffolds a project directory that is bound to your workspace: a fibric.json manifest, a TypeScript setup with @fibric/sdk installed, and an empty operators/ directory. Run it inside a new or existing directory.
mkdir acme-ops && cd acme-ops
fibric initIn the target contract, the manifest records a workspace slug and deployment paths propagate verified tenant context. This is a design requirement, not evidence that a public deployment workflow or every generalized-platform row is live.
Verify the installation
fibric whoami confirms that the CLI is installed, authenticated, and pointed at the workspace you expect. Run it before anything else; if this works, every other command will reach the platform.
fibric whoamiUpgrade and uninstall
The CLI is versioned with the platform; during the v1.0 preview, upgrade whenever a new release is announced in the changelog.
# upgrade to the latest release
npm install -g @fibric/cli@latest
# remove the CLI entirely
npm uninstall -g @fibric/cliUninstalling does not delete ~/.fibric/credentials. Remove that file by hand if you are decommissioning a machine, and rotate any API keys the machine held.
Troubleshooting
The three failures below account for nearly all installation problems.
| Symptom | Cause | Fix |
|---|---|---|
fibric: command not found |
The npm global bin directory is not on your PATH. |
Run npm prefix -g and add its bin subdirectory to PATH in your shell profile, then open a new shell. |
401 unauthorized on any command |
The API key was rotated or revoked, or a stale FIBRIC_API_KEY is shadowing a valid login. |
Issue a fresh key from Settings → API keys and update the environment, or unset FIBRIC_API_KEY and run fibric auth login again. |
EACCES during npm install -g |
The npm global prefix points at a directory your user cannot write, commonly a system location. | Set a user-owned prefix with npm config set prefix ~/.npm-global, add ~/.npm-global/bin to PATH, and reinstall. Do not install with sudo. |
Next steps
- Your first operator: a full tutorial from a connected system to a first receipt.
- Quickstart: the whole loop in ten minutes against a sandbox connector.
- CLI reference: every command, flag, and output format.