Skip to content
Preview

Installation

Install Flexor via CLI or npm. Prerequisites, supported environments, and first-run verification.

Last updated: 2026-04-30

Installation

Specification - implementation in progress. The commands and package names below reflect the specified Flexor CLI. The public npm package and hosted CLI are in active development. If you are a PLEXI client, your sandbox environment is pre-provisioned - contact your onboarding contact for credentials.

Prerequisites

RequirementVersion
Node.js>= 22.12.0
pnpm>= 9.0.0
Operating systemmacOS, Linux, or Windows (WSL2)

Install via npm

npm install -g @plexi/flexor-cli

Or with pnpm:

pnpm add -g @plexi/flexor-cli

Verify the installation:

flexor --version

Expected output:

flexor 0.1.0 (preview)

Install via Homebrew (macOS)

brew tap plexi/tap
brew install flexor

First-run initialization

After installing, initialize Flexor in a project directory:

mkdir my-flexor-project
cd my-flexor-project
flexor init

The init command creates the following structure:

my-flexor-project/
├── vault.json          # vault configuration and tier layout
├── vaults/
│   └── company/        # L2 company-level vault (pre-populated with defaults)
├── .flexor/
│   └── config.json     # local environment config (gitignored)
└── README.md

Connecting to a sandbox

If you have a PLEXI-provisioned sandbox account, authenticate:

flexor auth login --sandbox

This opens a browser window for credential entry. On success, your local config is updated with a session token.

To verify connectivity:

flexor status

Expected output:

Connected to: sandbox-<your-id>.flexor.plexl.ai
Vault: my-flexor-project
Agents: 0 configured
Skills: 12 available (standard library)

Uninstalling

npm uninstall -g @plexi/flexor-cli

The CLI does not write to locations outside your project directory and ~/.flexor/. Remove ~/.flexor/ to clear all local state.

Tip: Most Flexor deployments at PLEXI client firms are managed via the web-based dashboard, not the CLI. The CLI is the reference tool for configuration management and scripted deployments. Ask your PLEXI contact for dashboard access.

Was this page helpful?

Edit on GitHub