@swarmcraftai/cli 0.1.0
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/LICENSE.txt +20 -0
- package/README.md +79 -0
- package/dist/main.cjs +4312 -0
- package/package.json +41 -0
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
SwarmCraft Proprietary Software Notice
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SwarmCraft Pty Ltd.
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
This CLI is proprietary software. Access to and use of this CLI, its
|
|
7
|
+
documentation, and related SwarmCraft services is granted on a limited,
|
|
8
|
+
non-exclusive, revocable, non-transferable basis and remains subject to the
|
|
9
|
+
SwarmCraft legal terms.
|
|
10
|
+
|
|
11
|
+
Software License:
|
|
12
|
+
https://swarmcraft.ai/legal/software-license
|
|
13
|
+
|
|
14
|
+
Terms of Service:
|
|
15
|
+
https://swarmcraft.ai/legal/terms
|
|
16
|
+
|
|
17
|
+
Privacy Policy:
|
|
18
|
+
https://swarmcraft.ai/legal/privacy-policy
|
|
19
|
+
|
|
20
|
+
If you do not agree to those terms, do not use this software.
|
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# SwarmCraft CLI
|
|
2
|
+
|
|
3
|
+
Customer-facing command line tool for preparing a repository for a SwarmCraft project board and running packet-based one-shot work.
|
|
4
|
+
|
|
5
|
+
The CLI is separate from `apps/driver`. The driver remains internal scenario tooling for local operator runs, docs evidence, reports, and weekly validation. Customers should install and run the SwarmCraft CLI, not the internal driver scripts.
|
|
6
|
+
|
|
7
|
+
## Package Shape
|
|
8
|
+
|
|
9
|
+
- Package name: `@swarmcraftai/cli`
|
|
10
|
+
- Installed command: `swarmcraft`
|
|
11
|
+
- Supported runtime target: Node.js 20.19 or newer
|
|
12
|
+
- Local run artifact location: `.swarmcraft/runs/<run-id>` inside the selected customer workspace
|
|
13
|
+
- Public package contents: bundled CLI runtime, README, package metadata, and license
|
|
14
|
+
- Shared workspace packages are bundled into the CLI artifact; customers do not install `@swarmcraft/packet-workflow` or `@swarmcraft/repo-seed` directly.
|
|
15
|
+
|
|
16
|
+
## Distribution
|
|
17
|
+
|
|
18
|
+
The first public distribution channel is npm:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install -g @swarmcraftai/cli
|
|
22
|
+
swarmcraft --help
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
One-off use is also supported:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx @swarmcraftai/cli --help
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Public publishing is owned by the release workflow in `.github/workflows/publish-cli.yml`. Run the local package smoke before publishing:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
pnpm cli:release:smoke
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Local Development
|
|
38
|
+
|
|
39
|
+
From the repo root:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pnpm cli:dev -- --help
|
|
43
|
+
pnpm cli:check
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
From this package:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pnpm dev -- --help
|
|
50
|
+
pnpm check
|
|
51
|
+
pnpm release:smoke
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Current Commands
|
|
55
|
+
|
|
56
|
+
Core commands:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
swarmcraft auth login --email <email>
|
|
60
|
+
swarmcraft projects list
|
|
61
|
+
swarmcraft init --project <project-id> --workspace <path>
|
|
62
|
+
swarmcraft one-shot --project <project-id> --workspace <path> --agent-provider codex
|
|
63
|
+
swarmcraft one-shot --project <project-id> --workspace <path> --agent-provider codex --run-id <known-run-id>
|
|
64
|
+
swarmcraft resume --run <run-id> --workspace <path>
|
|
65
|
+
swarmcraft status --run <run-id> --workspace <path>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
`swarmcraft init` validates the workspace git state, seeds the shared SwarmCraft repo guidance files, materializes non-done ticket packets, links those packets back to SwarmCraft, and prints the next commands.
|
|
69
|
+
|
|
70
|
+
`swarmcraft one-shot` bootstraps the workspace, runs doing and checking through the selected agent provider, writes `.swarmcraft/runs/<run-id>/manifest.json`, and stops at reviewing by default. Use `--done-policy auto --commit-policy done` only when automatic done moves and commits are intended.
|
|
71
|
+
|
|
72
|
+
Useful safety and support commands:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
swarmcraft one-shot --project <project-id> --workspace <path> --agent-provider codex --max-agent-requests 40
|
|
76
|
+
swarmcraft one-shot --project <project-id> --workspace <path> --agent-provider custom --agent-command '<command with {command}>' --agent-api-key-env-name MY_AGENT_KEY
|
|
77
|
+
swarmcraft doctor --workspace <path> --agent-provider codex
|
|
78
|
+
swarmcraft support-bundle --run <run-id> --workspace <path>
|
|
79
|
+
```
|