rapidkit 0.42.1 → 0.42.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +127 -585
- package/dist/autopilot-release-PBDTSW4X.js +1 -0
- package/dist/{chunk-JN6R5UP4.js → chunk-4SYXFC4M.js} +1 -1
- package/dist/{chunk-NN3IV4U6.js → chunk-LK66ATAQ.js} +2 -2
- package/dist/{chunk-CXWWNQDF.js → chunk-MWVOWE5T.js} +1 -1
- package/dist/{create-TPFUONHK.js → create-XPYW3WJF.js} +1 -1
- package/dist/index.js +17 -17
- package/dist/{pipeline-PX6ZUINW.js → pipeline-YT57V6AL.js} +1 -1
- package/dist/{workspace-MPKEUHFP.js → workspace-NJFK6DAP.js} +1 -1
- package/dist/{workspace-foundation-2OVUZXPT.js → workspace-foundation-OTL2RSZP.js} +1 -1
- package/dist/workspace-run-BV2PIE3Y.js +1 -0
- package/docs/AI_DYNAMIC_INTEGRATION.md +5 -1
- package/docs/AI_EXAMPLES.md +5 -1
- package/docs/AI_FEATURES.md +6 -2
- package/docs/AI_QUICKSTART.md +4 -0
- package/docs/MIGRATING_TO_WORKSPAI.md +139 -0
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +4 -0
- package/docs/OPTIMIZATION_GUIDE.md +4 -0
- package/docs/README.md +12 -3
- package/docs/UTILITIES.md +4 -0
- package/docs/WORKSPACE_MARKER_SPEC.md +5 -0
- package/docs/commands-reference.md +5 -0
- package/docs/config-file-guide.md +4 -0
- package/docs/create-planner-capabilities.md +5 -0
- package/docs/doctor-command.md +5 -0
- package/docs/from-code-to-shared-understanding.md +5 -1
- package/docs/workspace-operations.md +5 -0
- package/docs/workspace-run.md +5 -0
- package/package.json +11 -6
- package/templates/kits/fastapi-ddd/README.md.j2 +6 -6
- package/templates/kits/fastapi-ddd/pyproject.toml.j2 +5 -5
- package/templates/kits/fastapi-ddd/src/cli.py.j2 +3 -3
- package/templates/kits/fastapi-standard/README.md.j2 +9 -9
- package/templates/kits/fastapi-standard/pyproject.toml.j2 +5 -5
- package/templates/kits/fastapi-standard/src/cli.py.j2 +3 -3
- package/templates/kits/nestjs-standard/README.md.j2 +8 -8
- package/templates/kits/nestjs-standard/package.json.j2 +1 -1
- package/dist/autopilot-release-5J55NPXF.js +0 -1
- package/dist/workspace-run-NULA72JV.js +0 -1
- /package/dist/{chunk-FLFZC7ZV.js → chunk-YVTVFYSI.js} +0 -0
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# {{ project_name | replace('_', ' ') | title }}
|
|
2
2
|
|
|
3
|
-
A minimal FastAPI service generated with the
|
|
3
|
+
A minimal FastAPI service generated with **RapidKit Core** using the FastAPI Standard Kit. It can be adopted into Workspai workspace intelligence when you want workspace-level context, evidence, and release governance.
|
|
4
4
|
|
|
5
5
|
## Quick start
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
# Load the project-
|
|
8
|
+
# Load the project-local RapidKit Core launcher (adds .rapidkit/rapidkit to PATH)
|
|
9
9
|
source .rapidkit/activate
|
|
10
10
|
|
|
11
11
|
# Bootstrap dependencies (creates .venv + installs Poetry-managed deps)
|
|
@@ -24,7 +24,7 @@ make audit
|
|
|
24
24
|
make dev
|
|
25
25
|
rapidkit dev # same as make dev but auto-detects the project
|
|
26
26
|
|
|
27
|
-
# Prefer RapidKit
|
|
27
|
+
# Prefer RapidKit Core helpers when you want it to resolve scripts automatically
|
|
28
28
|
rapidkit lint
|
|
29
29
|
rapidkit test
|
|
30
30
|
rapidkit start
|
|
@@ -36,33 +36,33 @@ rapidkit start
|
|
|
36
36
|
|
|
37
37
|
> Lockfiles are generated automatically during scaffolding. Set `RAPIDKIT_SKIP_LOCKS=1` (or `RAPIDKIT_GENERATE_LOCKS=0`) before running `rapidkit create` if you need to opt out.
|
|
38
38
|
|
|
39
|
-
> Want the
|
|
39
|
+
> Want the project-local RapidKit Core catalog? Run `rapidkit --help`. If this project is part of a Workspai workspace, run `npx workspai --help` from the workspace root for workspace intelligence commands.
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
43
43
|
## Local development
|
|
44
44
|
|
|
45
|
-
- `rapidkit init` bootstraps dependencies via the project-local
|
|
45
|
+
- `rapidkit init` bootstraps dependencies via the project-local RapidKit Core launcher (run it after sourcing `.rapidkit/activate`).
|
|
46
46
|
- `make init` is an optional alias for `rapidkit init` when you prefer Make targets.
|
|
47
47
|
- `make install` re-runs `rapidkit init` (unless you set `SKIP_INIT=1`) and refreshes developer tooling such as pre-commit hooks.
|
|
48
48
|
- `./bootstrap.sh` copies `.env.example` to `.env` (if missing) and runs `SKIP_INIT=1 make install` for you.
|
|
49
49
|
- `make dev` (or `rapidkit dev`) launches Uvicorn with the correct module path and reload settings.
|
|
50
50
|
- `make lint`, `make typecheck`, and `make test` wrap Ruff, mypy, and pytest for consistent CI parity.
|
|
51
51
|
- `make audit` shells out to `pip-audit` to surface vulnerable dependencies.
|
|
52
|
-
- Prefer `rapidkit lint`, `rapidkit test`, and `rapidkit start` if you want RapidKit to autodetect the virtualenv and command wiring.
|
|
52
|
+
- Prefer `rapidkit lint`, `rapidkit test`, and `rapidkit start` if you want RapidKit Core to autodetect the virtualenv and command wiring.
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
## Available commands
|
|
56
56
|
|
|
57
57
|
```bash
|
|
58
58
|
rapidkit init # 🔧 Bootstrap the project (create .venv + install deps)
|
|
59
|
-
make init # 🔧 Optional alias for rapidkit init (wraps the local
|
|
59
|
+
make init # 🔧 Optional alias for rapidkit init (wraps the local Core launcher)
|
|
60
60
|
./bootstrap.sh # 🪄 Copy env template + install hooks/tooling (idempotent)
|
|
61
61
|
rapidkit dev # 🚀 Start development server with hot reload
|
|
62
62
|
make dev # 🚀 Alternative via Makefile helper
|
|
63
63
|
rapidkit start # ⚡ Start production server
|
|
64
|
-
rapidkit lint # 🔧 Run lint checks via
|
|
65
|
-
rapidkit test # 🧪 Run pytest through RapidKit
|
|
64
|
+
rapidkit lint # 🔧 Run lint checks via RapidKit Core
|
|
65
|
+
rapidkit test # 🧪 Run pytest through RapidKit Core
|
|
66
66
|
make install # 📦 Install Poetry deps + hooks
|
|
67
67
|
make lint # ✅ Lint via Ruff + Black
|
|
68
68
|
make typecheck # 🔍 Run mypy on src
|
|
@@ -17,21 +17,21 @@ help = "src.cli:help_cmd"
|
|
|
17
17
|
|
|
18
18
|
[tool.poetry.dependencies]
|
|
19
19
|
python = "^{{ python_version }}"
|
|
20
|
-
fastapi = "^0.
|
|
21
|
-
uvicorn = { extras = ["standard"], version = "^0.
|
|
20
|
+
fastapi = "^0.139.0"
|
|
21
|
+
uvicorn = { extras = ["standard"], version = "^0.50.2" }
|
|
22
22
|
pydantic = "^2.12.5"
|
|
23
23
|
{% if has_settings -%}
|
|
24
|
-
pydantic-settings = { version = "^2.
|
|
24
|
+
pydantic-settings = { version = "^2.14.2", extras = ["yaml"] }
|
|
25
25
|
{% endif %}
|
|
26
26
|
# <<<inject:poetry-dependencies>>>
|
|
27
27
|
|
|
28
28
|
[tool.poetry.group.dev.dependencies]
|
|
29
|
-
pytest = "^9.0.
|
|
29
|
+
pytest = "^9.0.3"
|
|
30
30
|
pytest-asyncio = "^1.3.0"
|
|
31
31
|
pytest-cov = "^7.0.0"
|
|
32
32
|
httpx = "^0.28.1"
|
|
33
33
|
ruff = "^0.14.10"
|
|
34
|
-
black = "^
|
|
34
|
+
black = "^26.3.1"
|
|
35
35
|
isort = "^7.0.0"
|
|
36
36
|
mypy = "^1.19.1"
|
|
37
37
|
build = "^1.3.0"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env python3
|
|
2
2
|
"""Project CLI wrapper for {{ project_name }}.
|
|
3
3
|
|
|
4
|
-
This file prefers a per-project
|
|
4
|
+
This file prefers a per-project RapidKit Core wrapper (generated at `.rapidkit/cli.py`) when
|
|
5
5
|
available. If not present it prints helpful guidance directing users to
|
|
6
6
|
`rapidkit init` and does not attempt to make assumptions about a packaging
|
|
7
7
|
environment.
|
|
@@ -15,7 +15,7 @@ from typing import Optional
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
def _missing_cli(name: str) -> None:
|
|
18
|
-
print(f"❌ Missing project-local
|
|
18
|
+
print(f"❌ Missing project-local RapidKit Core wrapper (.rapidkit/cli.py) - can't run '{name}'")
|
|
19
19
|
print("💡 If you're a new user run: rapidkit init # create venv + install deps")
|
|
20
20
|
sys.exit(127)
|
|
21
21
|
|
|
@@ -36,7 +36,7 @@ def _load_project_cli_module() -> Optional[object]:
|
|
|
36
36
|
_mod = _load_project_cli_module()
|
|
37
37
|
|
|
38
38
|
|
|
39
|
-
# Default placeholders -- call `_missing_cli` if the project-local
|
|
39
|
+
# Default placeholders -- call `_missing_cli` if the project-local RapidKit Core wrapper isn't
|
|
40
40
|
# available. These are real functions so linters don't complain.
|
|
41
41
|
def init() -> None:
|
|
42
42
|
_missing_cli("init")
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# {{ project_name | replace('-', ' ') | title }}
|
|
2
2
|
|
|
3
|
-
A production-ready NestJS 11 application generated with RapidKit
|
|
3
|
+
A production-ready NestJS 11 application generated with **RapidKit Core** using the NestJS Standard Kit. It can be adopted into Workspai workspace intelligence when you want workspace-level context, evidence, and release governance.
|
|
4
4
|
|
|
5
5
|
## Getting Started
|
|
6
6
|
> Recommended Node version: `{{ node_version }}` (`.nvmrc` and `.node-version` are included for your toolchain)
|
|
7
7
|
|
|
8
8
|
```bash
|
|
9
|
-
# Load the project-
|
|
9
|
+
# Load the project-local RapidKit Core launcher (adds .rapidkit/rapidkit to PATH)
|
|
10
10
|
source .rapidkit/activate
|
|
11
11
|
|
|
12
|
-
# Bootstrap dependencies using
|
|
12
|
+
# Bootstrap dependencies using RapidKit Core
|
|
13
13
|
rapidkit init # use make init if you prefer a Make target
|
|
14
14
|
|
|
15
15
|
# Copy env templates + install hooks/tooling
|
|
@@ -18,7 +18,7 @@ rapidkit init # use make init if you prefer a Make target
|
|
|
18
18
|
# Run the dev server with hot reload
|
|
19
19
|
make dev
|
|
20
20
|
|
|
21
|
-
# Or rely on the project-
|
|
21
|
+
# Or rely on the project-local RapidKit Core helpers:
|
|
22
22
|
rapidkit dev
|
|
23
23
|
|
|
24
24
|
# Run linting, type-checking, tests, and supply-chain audits
|
|
@@ -36,13 +36,13 @@ rapidkit test
|
|
|
36
36
|
|
|
37
37
|
> Lockfiles are generated automatically during scaffolding. Set `RAPIDKIT_SKIP_LOCKS=1` (or `RAPIDKIT_GENERATE_LOCKS=0`) before running `rapidkit create` if you need to skip this step.
|
|
38
38
|
|
|
39
|
-
> Need the
|
|
39
|
+
> Need the project-local RapidKit Core command list? Run `rapidkit --help`. If this project is part of a Workspai workspace, run `npx workspai --help` from the workspace root for workspace intelligence commands.
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
43
43
|
## Quick start (developer)
|
|
44
44
|
|
|
45
|
-
1. `rapidkit init` (after `source .rapidkit/activate`) bootstraps dependencies through the project-local RapidKit
|
|
45
|
+
1. `rapidkit init` (after `source .rapidkit/activate`) bootstraps dependencies through the project-local RapidKit Core launcher and enforces lockfile flags for your chosen package manager.
|
|
46
46
|
2. `make init` remains available as an alias to `rapidkit init` when you prefer Make targets.
|
|
47
47
|
3. `./bootstrap.sh` copies `.env.example` to `.env` (when missing) and runs `SKIP_INIT=1 make install` so git hooks and tooling stay current without reinstalling packages.
|
|
48
48
|
4. `make dev` wraps `{{ package_manager if package_manager != 'pnpm' else 'pnpm' }} run start:dev` and centralizes env loading; use it for day-to-day development.
|
|
@@ -51,7 +51,7 @@ rapidkit test
|
|
|
51
51
|
|
|
52
52
|
`make install` is still available; it re-runs `rapidkit init` unless you set `SKIP_INIT=1`, so prefer `SKIP_INIT=1 make install` when you only need to refresh tooling.
|
|
53
53
|
|
|
54
|
-
Prefer `rapidkit dev`, `rapidkit test`, or `rapidkit lint` when you want
|
|
54
|
+
Prefer `rapidkit dev`, `rapidkit test`, or `rapidkit lint` when you want RapidKit Core to auto-detect the right runtime; they call into the same project scripts wrapped by the Make targets.
|
|
55
55
|
|
|
56
56
|
Prefer the Make targets for consistency, but you can always fall back to native commands if needed:
|
|
57
57
|
|
|
@@ -126,7 +126,7 @@ docker-compose down
|
|
|
126
126
|
| `{{ package_manager if package_manager != 'pnpm' else 'pnpm' }} test` | Run tests |
|
|
127
127
|
|
|
128
128
|
---
|
|
129
|
-
Generated with
|
|
129
|
+
Generated with RapidKit Core. Compatible with Workspai workspace intelligence.
|
|
130
130
|
|
|
131
131
|
## 📄 License
|
|
132
132
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "{{ project_name | replace('_', '-') | lower }}",
|
|
3
3
|
"version": "{{ app_version | default('1.0.0') }}",
|
|
4
|
-
"description": "{{ description | default('NestJS application generated with RapidKit') }}",
|
|
4
|
+
"description": "{{ description | default('NestJS application generated with RapidKit Core') }}",
|
|
5
5
|
"license": "{{ license | default('Apache-2.0') }}",
|
|
6
6
|
"author": "{{ author }}",
|
|
7
7
|
"engines": {
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export{b as AUTOPILOT_RELEASE_ALIAS_FILENAME,a as AUTOPILOT_RELEASE_LAST_RUN_FILENAME,c as runAutopilotRelease}from'./chunk-CXWWNQDF.js';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export{a as runWorkspaceStage}from'./chunk-FLFZC7ZV.js';export{a as WORKSPACE_RUN_LAST_REPORT_FILENAME}from'./chunk-64RTZBHU.js';
|
|
File without changes
|