{"id":32773673,"url":"https://github.com/getrapidkit/rapidkit-npm","last_synced_at":"2026-04-19T22:18:42.314Z","repository":{"id":321999426,"uuid":"1081781406","full_name":"getrapidkit/rapidkit-npm","owner":"getrapidkit","description":"🚀 Official CLI for RapidKit - Create FastAPI and NestJS workspaces with demo templates. Zero config, production-ready projects in seconds.","archived":false,"fork":false,"pushed_at":"2026-02-22T06:28:20.000Z","size":1170,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-22T13:04:18.083Z","etag":null,"topics":["api","backend","boilerplate","cli","developer-tools","fastapi","frameworks","generator","microservices","nestjs","python","rapidkit","scaffold","typescript","workspace"],"latest_commit_sha":null,"homepage":"https://www.getrapidkit.com/rapidkit-npm","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getrapidkit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-23T09:26:10.000Z","updated_at":"2026-02-22T06:28:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/getrapidkit/rapidkit-npm","commit_stats":null,"previous_names":["getrapidkit/rapidkit-npm"],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/getrapidkit/rapidkit-npm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getrapidkit%2Frapidkit-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getrapidkit%2Frapidkit-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getrapidkit%2Frapidkit-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getrapidkit%2Frapidkit-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getrapidkit","download_url":"https://codeload.github.com/getrapidkit/rapidkit-npm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getrapidkit%2Frapidkit-npm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29719344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T15:10:41.462Z","status":"ssl_error","status_checked_at":"2026-02-22T15:10:04.636Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","boilerplate","cli","developer-tools","fastapi","frameworks","generator","microservices","nestjs","python","rapidkit","scaffold","typescript","workspace"],"created_at":"2025-11-04T10:01:07.117Z","updated_at":"2026-04-19T22:18:42.306Z","avatar_url":"https://github.com/getrapidkit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RapidKit NPM CLI\n\n\u003e RapidKit is an open-source workspace platform that standardizes how teams build, scale, and deploy backend services.\n\nFastAPI, NestJS, Go/Fiber, and Go/Gin scaffolding with production-ready defaults.  \n**27+ plug-and-play modules** are available for FastAPI \u0026 NestJS projects.  \nClean architecture • Zero boilerplate • Instant deployment.\n\n\u003e **💡 Recommended:** Install the [Workspai VS Code extension](https://github.com/getrapidkit/rapidkit-vscode) for AI-powered project creation, a visual workspace explorer, and context-aware coding assistance — all backed by this CLI.\n\n[![npm version](https://img.shields.io/npm/v/rapidkit.svg?style=flat-square)](https://www.npmjs.com/package/rapidkit)\n[![Downloads](https://img.shields.io/npm/dm/rapidkit.svg?style=flat-square)](https://www.npmjs.com/package/rapidkit)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)\n[![GitHub Stars](https://img.shields.io/github/stars/getrapidkit/rapidkit-npm.svg?style=flat-square)](https://github.com/getrapidkit/rapidkit-npm/stargazers)\n[![Built by RapidKit](https://img.shields.io/badge/Built%20by-RapidKit-0f172a?logo=github)](https://www.getrapidkit.com)\n\nOfficial CLI for creating and operating RapidKit workspaces and projects.\n\n- Workspace-first lifecycle (`create workspace` → `bootstrap` → `setup` → `create project`)\n- Multi-runtime support (Python, Node.js, Go)\n- Profile + policy enforcement (`warn` / `strict`)\n- Cache and mirror lifecycle commands for stable environments\n\n## RapidKit CLI in the Workspai Ecosystem\n\nThe `rapidkit` npm package remains the official RapidKit CLI.\n\nIt works alongside Workspai, which is a product developed by RapidKit.\n\n| Component | Repository | Role |\n|---|---|---|\n| CLI | [getrapidkit/rapidkit-npm](https://github.com/getrapidkit/rapidkit-npm) | Official RapidKit npm CLI |\n| VS Code Extension | [getrapidkit/rapidkit-vscode](https://github.com/getrapidkit/rapidkit-vscode) | **Workspai** — visual explorer + AI features (recommended) |\n| Core Engine | [getrapidkit/rapidkit-core](https://github.com/getrapidkit/rapidkit-core) | Official RapidKit Core |\n| Examples | [getrapidkit/rapidkit-examples](https://github.com/getrapidkit/rapidkit-examples) | Example workspaces and starter references |\n\n## Requirements\n\n- Node.js `\u003e= 20.19.6`\n- Python `\u003e= 3.10` (for Python/Core workflows)\n- Go (optional, for Go projects)\n\n## Install\n\n```bash\nnpm install -g rapidkit\n```\n\nOr run directly with `npx`:\n\n```bash\nnpx rapidkit --help\n```\n\nAll three commands above render the same root help output.\n\n## Quick Start (Recommended)\n\n### 1) Create a workspace\n\n```bash\nnpx rapidkit create workspace my-workspace --yes --profile polyglot\ncd my-workspace\n```\n\n### 2) Bootstrap and setup runtimes\n\n```bash\nnpx rapidkit bootstrap --profile polyglot\nnpx rapidkit setup python\nnpx rapidkit setup node --warm-deps\nnpx rapidkit setup go --warm-deps\n```\n\n### 3) Create projects\n\n```bash\nnpx rapidkit create project fastapi.standard my-api --yes --skip-install\nnpx rapidkit create project nestjs.standard my-nest --yes --skip-install\nnpx rapidkit create project gofiber.standard my-fiber --yes --skip-install\n```\n\n## Core Commands\n\n### Workspace lifecycle\n\n```bash\nnpx rapidkit create # Prompts: workspace | project\nnpx rapidkit create workspace \u003cname\u003e [--profile \u003cprofile\u003e] [--author \u003cname\u003e] [--yes]\nnpx rapidkit bootstrap [--profile \u003cprofile\u003e] [--json]\nnpx rapidkit setup \u003cpython|node|go\u003e [--warm-deps]\nnpx rapidkit workspace policy show\nnpx rapidkit workspace policy set \u003ckey\u003e \u003cvalue\u003e\nnpx rapidkit doctor\nnpx rapidkit doctor workspace [--fix]\nnpx rapidkit workspace list # Display all workspaces created on this system\n```\n\n### Command ownership\n\nRapidKit keeps the wrapper boundary explicit so users know which layer owns each action.\n\n| Command family | Owner | Notes |\n|---|---|---|\n| `create workspace`, `workspace`, `cache`, `mirror` | RapidKit wrapper | Platform-level orchestration |\n| `init` | Wrapper orchestrated | Chooses the right runtime flow for the current project |\n| `dev`, `test`, `build`, `start` | Runtime aware | Delegates to the active project/runtime when available |\n| `doctor` | Wrapper system check | Checks host prerequisites by default |\n| `doctor workspace` | Workspace health | Full workspace scan with project-level details and fixes |\n\nUse `npx rapidkit doctor` for a quick host pre-flight and `npx rapidkit doctor workspace` inside a workspace for the full health picture.\n\n### Doctor workspace fix behavior\n\n- `npx rapidkit doctor workspace` reuses cached project scans when valid and refreshes evidence under `.rapidkit/reports/doctor-last-run.json`.\n- `npx rapidkit doctor workspace --fix` only executes actionable fix commands.\n- URL-based fixes are recorded as manual guidance (for example, install pages) and are not executed as shell commands.\n- Go project fixes that require `go mod tidy` are skipped when the Go toolchain is not available, with a clear install-and-rerun hint.\n\n### Project lifecycle\n\n```bash\nnpx rapidkit create project \u003ckit\u003e \u003cname\u003e [--yes] [--skip-install]\nnpx rapidkit init\nnpx rapidkit dev\nnpx rapidkit test\nnpx rapidkit build\nnpx rapidkit start\n```\n\n### Operations\n\n```bash\nnpx rapidkit cache \u003cstatus|clear|prune|repair\u003e\nnpx rapidkit mirror \u003cstatus|sync|verify|rotate\u003e\n```\n\n## Profiles\n\n- `minimal` — baseline workspace scaffolding\n- `python-only` — Python-focused workspace\n- `node-only` — Node.js-focused workspace\n- `go-only` — Go-focused workspace\n- `polyglot` — Python + Node.js + Go\n- `enterprise` — polyglot + governance-oriented checks\n\n## Policy Modes\n\n`mode` in `.rapidkit/policies.yml` controls enforcement:\n\n- `warn` (default): report violations, continue\n- `strict`: block incompatible operations\n\n## Workspace Policy Management\n\nManage `.rapidkit/policies.yml` via CLI (recommended, avoids manual YAML edits):\n\n```bash\nnpx rapidkit workspace policy show\nnpx rapidkit workspace policy set mode strict\nnpx rapidkit workspace policy set dependency_sharing_mode shared-runtime-caches\nnpx rapidkit workspace policy set rules.enforce_toolchain_lock true\n```\n\nSupported keys:\n- `mode`\n- `dependency_sharing_mode`\n- `rules.enforce_workspace_marker`\n- `rules.enforce_toolchain_lock`\n- `rules.disallow_untrusted_tool_sources`\n- `rules.enforce_compatibility_matrix`\n- `rules.require_mirror_lock_for_offline`\n\n## Setup and Warm Dependencies\n\n`setup \u003cruntime\u003e` validates toolchain and updates `.rapidkit/toolchain.lock`.\n\n`--warm-deps` adds optional dependency warm-up:\n\n- Node: lock/dependency warm-up in Node project directories\n- Go: module warm-up in Go project directories\n- Python: accepted, currently reports node/go scope\n\nWarm-deps behavior is non-fatal by design and reports explicit outcome (`completed` / `failed` / `skipped`).\n\n## VS Code Extension (Recommended)\n\nFor the best RapidKit experience, use the **Workspai VS Code extension** — it wraps this CLI with a\nvisual workspace explorer, AI-powered project creation, and context-aware coding assistance.\n\n### Why use the extension?\n\n| Feature | CLI | Extension |\n|---|---|---|\n| Create workspace / project | ✅ | ✅ Visual wizard |\n| AI Create — describe → scaffold | ❌ | ✅ |\n| Project Assistant (context-aware Q\u0026A) | ❌ | ✅ |\n| Workspace tree explorer | ❌ | ✅ |\n| Module catalog browser | ❌ | ✅ |\n| One-click `rapidkit init / dev / test` | ❌ | ✅ |\n| Inline AI on every workspace item | ❌ | ✅ |\n\n### Install\n\nSearch **Workspai** in the VS Code Extensions marketplace, or:\n\n```bash\ncode --install-extension getrapidkit.workspai\n```\n\n\u003e The extension calls this CLI under the hood — both tools work together seamlessly.\n\u003e You do **not** need to install the CLI separately when using the extension.\n\n- Extension repository: https://github.com/getrapidkit/rapidkit-vscode\n\n## CI Workflow Ownership Map\n\nUse this map to avoid overlap when editing CI:\n\n- `.github/workflows/ci.yml`\n  - Build/lint/typecheck/tests/coverage matrix\n  - General quality and contract gates\n- `.github/workflows/workspace-e2e-matrix.yml`\n  - Cross-OS workspace lifecycle smoke\n  - Setup (`--warm-deps`) + cache/mirror ops\n  - Chaos/non-fatal warm-deps behavior (Ubuntu job)\n- `.github/workflows/windows-bridge-e2e.yml`\n  - Native Windows bridge/lifecycle checks\n- `.github/workflows/e2e-smoke.yml`\n  - Focused bridge regression smoke (fast, narrow scope)\n- `.github/workflows/security.yml`\n  - Security scanning and policy checks\n\n## Documentation Index\n\nPrimary docs live under `docs/`:\n\n- General docs index: [docs/README.md](docs/README.md)\n- Setup details: [docs/SETUP.md](docs/SETUP.md)\n- Doctor command: [docs/doctor-command.md](docs/doctor-command.md)\n- Workspace marker spec: [docs/WORKSPACE_MARKER_SPEC.md](docs/WORKSPACE_MARKER_SPEC.md)\n- Config file guide: [docs/config-file-guide.md](docs/config-file-guide.md)\n- Package manager policy: [docs/PACKAGE_MANAGER_POLICY.md](docs/PACKAGE_MANAGER_POLICY.md)\n- Security: [docs/SECURITY.md](docs/SECURITY.md)\n- Development: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)\n\n## Development\n\n```bash\nnpm ci\nnpm run build\nnpm run test\nnpm run lint\nnpm run typecheck\n```\n\nLink local CLI globally for manual testing:\n\n```bash\nnpm run install:local\nnpx rapidkit --version\n```\n\n## Troubleshooting\n\n- If setup output looks stale, run `npx rapidkit setup \u003cruntime\u003e` again to refresh `.rapidkit/toolchain.lock`.\n- If dependency warm-up is skipped, verify you are inside the corresponding project directory (`package.json` for Node, `go.mod` for Go).\n- For strict-mode blocks, inspect `.rapidkit/policies.yml` and workspace profile in `.rapidkit/workspace.json`.\n\n## License\n\nMIT — see [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetrapidkit%2Frapidkit-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetrapidkit%2Frapidkit-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetrapidkit%2Frapidkit-npm/lists"}