@boboddy/cli 0.6.2 → 0.6.4

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.
Files changed (2) hide show
  1. package/README.md +16 -134
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,146 +1,28 @@
1
- # boboddy CLI
1
+ # @boboddy/cli
2
2
 
3
- `boboddy` is a Bun + TypeScript CLI workspace with a modular command layout and compiled binary distribution support.
3
+ Boboddy runs AI agents over your backlog, on your machines. This CLI links your
4
+ repo, designs pipelines with an agent, and runs the workers that execute them.
4
5
 
5
- ## Project Shape
6
-
7
- ```txt
8
- apps/cli/
9
- src/
10
- index.ts
11
- commands/
12
- hello.ts
13
- script/
14
- build.ts
15
- bin/
16
- boboddy
17
- test/
18
- cli.test.ts
19
- package.json
20
- tsconfig.json
21
- README.md
22
- ```
23
-
24
- ## Prerequisites
25
-
26
- - Bun `1.2.9` or newer
27
-
28
- ## Local Development
29
-
30
- Install dependencies from the workspace root:
31
-
32
- ```sh
33
- bun install
34
- ```
35
-
36
- Run the CLI directly from source:
37
-
38
- ```sh
39
- bun run apps/cli/src/index.ts hello
40
- bun run apps/cli/src/index.ts hello Connor
41
- bun run apps/cli/src/index.ts work 01966a2c-9494-7db5-aa46-0f8f5cbbe001
42
- bun run apps/cli/src/index.ts auth status
43
- ```
44
-
45
- Or from the package directory:
46
-
47
- ```sh
48
- cd apps/cli
49
- bun run src/index.ts hello Connor
50
- bun run src/index.ts work 01966a2c-9494-7db5-aa46-0f8f5cbbe001
51
- ```
52
-
53
- ## Type Checking
54
-
55
- ```sh
56
- bun run --filter @boboddy/cli typecheck
57
- ```
58
-
59
- ## Tests
60
-
61
- ```sh
62
- bun run --filter @boboddy/cli test
63
- ```
64
-
65
- The tests spawn the CLI as a subprocess, so they do not require a global install.
66
-
67
- ## Build Binaries
6
+ ## Install
68
7
 
69
8
  ```sh
70
- bun run --filter @boboddy/cli build
9
+ npm i -g @boboddy/cli
71
10
  ```
72
11
 
73
- This creates standalone binaries in `apps/cli/dist/` for:
74
-
75
- - `boboddy-darwin-arm64`
76
- - `boboddy-darwin-x64`
77
- - `boboddy-linux-x64`
78
- - `boboddy-linux-arm64`
79
- - `boboddy-windows-x64.exe`
80
-
81
- ## npm Bin Wrapper
82
-
83
- The package publishes the `boboddy` executable through `bin/boboddy`.
84
-
85
- - The wrapper detects the current platform and architecture.
86
- - It runs the matching compiled binary from `dist/` when available.
87
- - It prints a clear error when the current platform is unsupported or the expected binary is missing.
88
-
89
- After building, run the wrapper locally:
12
+ ## Use
90
13
 
91
14
  ```sh
92
- ./bin/boboddy hello Connor
93
- ./bin/boboddy auth login
15
+ boboddy init # sign in and link this repo to a Boboddy project
16
+ boboddy pipelines design # pick a work item; an agent interviews you and writes the pipeline
17
+ boboddy work # run a worker that executes your pipeline's steps
94
18
  ```
95
19
 
96
- ## Authentication
97
-
98
- Authenticate the CLI through the browser-based Better Auth device flow:
99
-
100
- ```sh
101
- boboddy auth login
102
- boboddy auth status
103
- boboddy auth whoami
104
- boboddy auth logout
105
- ```
106
-
107
- By default the CLI targets `http://127.0.0.1:3000`. Override that with
108
- `--base-url` or the `BOBODDY_BASE_URL` environment variable.
109
-
110
- Authenticated CLI credentials are stored in `~/.boboddy/auth.jsonc`.
111
-
112
- ## Observability
113
-
114
- The CLI reports a small set of onboarding milestones (init started,
115
- requirements verified, signed in, project linked, designer launched, dry run
116
- passed, pipeline pushed, run queued) directly to PostHog. Each event is keyed
117
- to a random anonymous id persisted in `~/.boboddy/config.jsonc` until you sign in, at
118
- which point later events switch to your account id. `accessToken`, `email`,
119
- and `name` are never sent as event data.
120
-
121
- ```sh
122
- boboddy telemetry status # is it enabled?
123
- boboddy telemetry disable # opt out, persists across invocations
124
- boboddy telemetry enable # opt back in
125
- ```
126
-
127
- `BOBODDY_TELEMETRY_DISABLED=1` opts out for a single invocation without
128
- touching `~/.boboddy/config.jsonc`. `BOBODDY_TELEMETRY_DEBUG=1` prints every payload
129
- to stderr in addition to sending it. See the
130
- [Observability docs](https://boboddy-dev.github.io/boboddy/reference/observability/)
131
- for the full list of what's collected.
132
-
133
- ## npm-Style Installation
134
-
135
- When this workspace is published as a package, the `bin` field maps the `boboddy` command to `./bin/boboddy`.
136
-
137
- Typical install and usage shape:
138
-
139
- ```sh
140
- npm install -g <published-package-name>
141
- boboddy hello Connor
142
- ```
20
+ The designer connects to an AI provider once, the first time it starts. The
21
+ Quickstart says
22
+ [which option to pick for your tool](https://boboddy-dev.github.io/boboddy/getting-started/quickstart/#connect-your-ai-tool).
143
23
 
144
- ## Future GitHub Releases
24
+ ## Docs
145
25
 
146
- For GitHub Releases, upload the compiled files from `apps/cli/dist/` as release assets. Consumers can then download the platform-specific binary directly without installing through npm.
26
+ - [Quickstart](https://boboddy-dev.github.io/boboddy/getting-started/quickstart/) — ten minutes to a running pipeline.
27
+ - [CLI reference](https://boboddy-dev.github.io/boboddy/reference/cli/) — every command and flag.
28
+ - [Observability](https://boboddy-dev.github.io/boboddy/reference/observability/) — what the CLI reports and how to opt out.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@boboddy/cli",
3
- "version": "0.6.2",
3
+ "version": "0.6.4",
4
4
  "bin": {
5
5
  "boboddy": "bin/boboddy"
6
6
  },
@@ -17,11 +17,11 @@
17
17
  "pino-pretty": "^13.1.2"
18
18
  },
19
19
  "optionalDependencies": {
20
- "@boboddy/cli-darwin-arm64": "0.6.2",
21
- "@boboddy/cli-darwin-x64": "0.6.2",
22
- "@boboddy/cli-linux-x64": "0.6.2",
23
- "@boboddy/cli-linux-arm64": "0.6.2",
24
- "@boboddy/cli-win32-x64": "0.6.2"
20
+ "@boboddy/cli-darwin-arm64": "0.6.4",
21
+ "@boboddy/cli-darwin-x64": "0.6.4",
22
+ "@boboddy/cli-linux-x64": "0.6.4",
23
+ "@boboddy/cli-linux-arm64": "0.6.4",
24
+ "@boboddy/cli-win32-x64": "0.6.4"
25
25
  },
26
26
  "repository": {
27
27
  "type": "git",