RapidKit npm compatibility CLI

[!IMPORTANT] rapidkit is the legacy npm compatibility package. It remains available for existing users and automation during the migration window, but it is planned for deprecation in a future release. New projects and new integrations should use Workspai.

RapidKit helped establish the workspace-oriented CLI that now continues in Workspai. This repository is maintained for compatibility, security fixes, and safe migration—not as the starting point for new Workspace Intelligence work.

Choose the right path

| If you are… | Use | Start here | | --- | --- | --- | | Creating a new workspace or integration | workspai | Workspai CLI | | Connecting an existing project for the first time | workspai adopt | Adopt an existing project | | Maintaining a script that already calls rapidkit | rapidkit compatibility CLI | Legacy command access | | Migrating an existing RapidKit workspace | Workspai migration path | Migration guide |

Start new work with Workspai

You do not need to move an existing project or create a workspace by hand. From the project directory:

cd /path/to/your-project
npx workspai adopt .

Workspai keeps the source in place and creates or reuses the managed minimal workspace at:

~/.workspai/workspaces/workspai

Continue from the workspace path printed by the CLI:

cd ~/.workspai/workspaces/workspai
npx workspai workspace intelligence run \
  --for-agent generic \
  --strict \
  --json

That chain builds the current workspace model and proof-backed graph, checks health and contracts, assesses readiness, verifies the evidence, and prepares bounded context for agent and IDE consumers.

• Workspai documentation: workspai.dev
• Product overview: workspai.com
• Source: chistiq/workspai

Move an existing project to Workspai

The shortest safe migration is adoption in place:

cd /path/to/existing-project
npx workspai adopt .

The project stays where it is. Workspai writes canonical .workspai metadata and registers the source with a managed workspace. Do not rename .rapidkit directories to .workspai manually; the schemas, ownership, and artifact paths are versioned contracts rather than interchangeable folder names.

For several related projects, create one named workspace and adopt each project into that boundary:

npx workspai create workspace my-workspace --profile minimal --yes

cd /path/to/frontend
npx workspai adopt . \
  --workspace "$HOME/.workspai/workspaces/my-workspace"

cd /path/to/api
npx workspai adopt . \
  --workspace "$HOME/.workspai/workspaces/my-workspace"

See Migrating from RapidKit npm to Workspai for CI, workspace, project, and rollback guidance.

Legacy command access

Existing installations and scripts can continue to inspect the compatibility surface:

npx rapidkit --help
npx rapidkit --version

Common maintenance commands remain documented for current RapidKit users:

npx rapidkit doctor workspace
npx rapidkit setup <python|node|go|java|dotnet> [--warm-deps]
npx rapidkit workspace list
npx rapidkit cache <status|clear|prune|repair>
npx rapidkit mirror <status|sync|verify|rotate>

Do not use these examples as the foundation of a new integration. Their canonical Workspai equivalents and newer .workspai artifacts live in the Workspai CLI repository.

Migration map

| Legacy RapidKit | Canonical Workspai | | --- | --- | | npx rapidkit adopt . | npx workspai adopt . | | npx rapidkit create workspace my-workspace | npx workspai create workspace my-workspace | | npx rapidkit create project <kit> <name> | npx workspai create project <kit> <name> | | npx rapidkit workspace model --json | npx workspai workspace model --write --json | | npx rapidkit pipeline --json --strict | npx workspai pipeline --json --strict | | .rapidkit/** | .workspai/** generated through Workspai commands | | ~/rapidkit/workspaces/** | ~/.workspai/workspaces/** for new managed workspaces |

Command names may look similar, but migration is not a directory rename. Run Workspai so it can create and validate the canonical contracts.

Compatibility and maintenance policy

During the migration window this repository accepts:

• security and dependency updates;
• critical compatibility and cross-platform fixes;
• contract-bridge corrections needed by existing consumers;
• migration documentation and regression tests.

New Workspace Intelligence features, new public integrations, and new user journeys belong in chistiq/workspai. No final deprecation date is declared here; it will be announced explicitly before the npm package is marked deprecated.

Legacy documentation

The documentation in this repository describes the existing rapidkit compatibility surface and .rapidkit artifacts. It is retained for users who still operate that version:

• Legacy documentation index
• Legacy command reference
• Workspace operations
• Runtime support matrix
• Artifact catalog
• Security policy

For current product documentation, use workspai.dev.

Related repositories

• chistiq/rapidkit-npm — this legacy npm compatibility package
• chistiq/rapidkit-core — RapidKit Core and historical engine integration
• chistiq/rapidkit-vscode — the Workspai experience for VS Code
• chistiq/workspai — canonical CLI and active Workspace Intelligence development

Contributors and maintainers

This repository is still tested because migration software must remain safe.

corepack npm ci
corepack npm run build
corepack npm run validate
corepack npm run validate:docs
corepack npm run validate:contracts

Workflow ownership is documented in docs/ci-workflows.md. Current CI includes the build and test matrix, workspace E2E, Windows bridge E2E, package smoke, and security audit.

See CONTRIBUTING.md before proposing a change. Feature work that targets the canonical CLI should be opened against chistiq/workspai.

Security

Please report vulnerabilities through the process in docs/SECURITY.md. Do not publish sensitive details in a public issue.

License

MIT — see LICENSE.