caique 0.1.0 → 0.1.1

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +38 -4
  3. package/package.json +2 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Ofri Peretz
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,4 +1,22 @@
1
- # caique
1
+ <p align="center">
2
+ <a href="https://github.com/ofri-peretz/burgee/tree/main/packages/caique" target="blank">
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ofri-peretz/burgee/main/brand-assets/caique-lockup.svg" />
5
+ <img src="https://raw.githubusercontent.com/ofri-peretz/burgee/main/brand-assets/caique-lockup-light.svg" alt="caique" width="360" />
6
+ </picture>
7
+ </a>
8
+ </p>
9
+
10
+ <p align="center">
11
+ Prompts that are flags first — so an agent answers before it is asked, and nothing ever hangs.
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="https://www.npmjs.com/package/caique"><img src="https://img.shields.io/npm/v/caique?style=flat-square&color=0a6b47" alt="npm version" /></a>
16
+ <img src="https://img.shields.io/badge/status-pre--release-a84c17?style=flat-square" alt="Status: pre-release" />
17
+ <img src="https://img.shields.io/badge/runtime%20dependencies-0-0a6b47?style=flat-square" alt="Zero runtime dependencies" />
18
+ <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="License: MIT" />
19
+ </p>
2
20
 
3
21
  **Pre-release.** The first working slice is here — `decide()`, below — and the rest follows
4
22
  [`.sdlc/intents/caique/`](https://github.com/ofri-peretz/burgee/tree/main/.sdlc/intents/caique).
@@ -174,6 +192,22 @@ counted whole across its own resolved tree.
174
192
  - **Accessible mode** falls back to line input with no live redraw.
175
193
  - **Drop-in paths** for inquirer and clack, graded by their own suites.
176
194
 
177
- Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on burgee declares
178
- what it is, roundel carries its colours, flagstaff flies it, caique answers back. Each is
179
- an independent package; none requires the others.
195
+ ## Following along
196
+
197
+ The intent and design are committed before the code is, so you can read what it will be —
198
+ and argue with it — before it exists:
199
+
200
+ - [`.sdlc/intents/caique/`](https://github.com/ofri-peretz/burgee/tree/main/.sdlc/intents/caique)
201
+ — the intent and the design.
202
+ - [Open an issue](https://github.com/ofri-peretz/burgee/issues) if a prompt in your CLI
203
+ cannot be expressed as a flag. That case is the interesting one.
204
+
205
+ ---
206
+
207
+ Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on
208
+ [burgee](https://www.npmjs.com/package/burgee) declares what it is,
209
+ [roundel](https://www.npmjs.com/package/roundel) carries its colours,
210
+ [flagstaff](https://www.npmjs.com/package/flagstaff) flies it, and caique answers back. Each
211
+ is an independent package; none requires the others.
212
+
213
+ MIT © Ofri Peretz — see [LICENSE](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "caique",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "The parrot that always answers back, and the boat that goes between ship and shore. Prompts that are flags first, so agents answer before they are asked and non-TTY callers get an error naming the flag, never a hang. Drop-in path for inquirer and clack.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -53,6 +53,7 @@
53
53
  "build": "tsc -p tsconfig.build.json",
54
54
  "typecheck": "tsc -p tsconfig.json --noEmit",
55
55
  "test": "vitest run --passWithNoTests",
56
+ "coverage": "vitest run --coverage.enabled",
56
57
  "lint": "eslint src"
57
58
  },
58
59
  "repository": {