projectinator 0.1.0 → 0.1.2

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 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,7 +4,9 @@
4
4
 
5
5
  # Projectinator
6
6
 
7
+ [![npm](https://img.shields.io/npm/v/projectinator.svg?color=e0a72d&label=npm)](https://www.npmjs.com/package/projectinator)
7
8
  ![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)
9
+ ![node](https://img.shields.io/badge/node-%E2%89%A520-brightgreen.svg)
8
10
  ![tests: 134 passing](https://img.shields.io/badge/tests-134%20passing-brightgreen.svg)
9
11
  ![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6.svg)
10
12
  ![built on Pi](https://img.shields.io/badge/built%20on-Pi%20agent%20harness-e0a72d.svg)
@@ -16,14 +18,21 @@ watch it happen from a terminal cockpit: a live board, budget bar, and a standup
16
18
 
17
19
  Built on the [Pi](https://pi.dev) agent harness (Node/TypeScript). Bring your own API key.
18
20
 
19
- **Run it — no clone needed** (Node ≥ 20):
21
+ **Install & run** (Node ≥ 20):
20
22
 
21
23
  ```bash
22
- npx github:smanookian/projectinator
24
+ npx projectinator # run without installing
25
+ # or
26
+ npm install -g projectinator # then just: projectinator
23
27
  ```
24
28
 
29
+ > **It's a CLI, not a library.** `npm install projectinator` (without `-g`) only drops it into a
30
+ > project's `node_modules` — it won't create a runnable command. Use `npx projectinator` or
31
+ > `npm install -g projectinator`. (If `-g` installs but the command isn't found, npm's global
32
+ > bin dir isn't on your `PATH` — run `npm prefix -g` to locate it, or just use `npx`.)
33
+
25
34
  Then, inside the app: **Settings → API keys** and paste an Anthropic, OpenAI, or Gemini key
26
- (stored at `~/.projectinator`, never in the repo). That's it — pick **New build** and go.
35
+ (stored under `~/.projectinator`, never in the repo). That's it — pick **New build** and go.
27
36
 
28
37
  <details>
29
38
  <summary>Run from source instead</summary>
@@ -71,7 +80,7 @@ Type an idea → it plans → you approve → it builds, tests, and hands you wo
71
80
  | 🚀 **Deploy** | One click to Cloudflare Pages, Vercel, or Netlify (their CLI + your login). |
72
81
  | 📤 **Export** | Backlog → Markdown, CSV, **Jira** CSV, **Trello** CSV. |
73
82
  | 📜 **Git per build** | The workspace is a git repo; one commit per task. History view + **undo a task**. |
74
- | 📊 **Analytics** | Retro (with optional AI narrative), burndown, cost-by-epic/model, estimate accuracy, portfolio dashboard. |
83
+ | 📊 **Analytics** | Retro (with optional AI narrative), burndown, cost by epic/model, and estimate accuracy that self-calibrates from real runs. |
75
84
  | 💾 **Templates** | Save a project's brief as a reusable template; import/share as a file. |
76
85
 
77
86
  ## How it works
@@ -98,7 +107,7 @@ Real, unedited output from a full build, kept in [`examples/`](examples/):
98
107
  - **[Tip calculator](examples/tip-calculator/)** — PM → design → 3× code → test, $0.46,
99
108
  tester PASS. Three separate files (`index.html`, `styles.css`, `app.js`) that run on
100
109
  double-click (`file://`) *and* over http — the regression artifact for the
101
- ["runs on double-click" guarantee](#caveats-read-before-shipping-publicly).
110
+ ["runs on double-click" guarantee](#good-to-know).
102
111
 
103
112
  ## CLI (same engine, for scripting/CI)
104
113
 
@@ -118,9 +127,9 @@ npm run typecheck
118
127
  - **Settings** (in the app): API keys, preferred provider, default workflow, default stack,
119
128
  model assignments, budget cap + alert %, estimate accuracy.
120
129
  - **User data** lives under `~/.projectinator/` (config, calibration, templates, exports).
121
- Builds go to `.workspace/` in the repo.
130
+ Each build gets its own git-versioned workspace folder (one commit per finished task).
122
131
 
123
- ## Caveats (read before shipping publicly)
132
+ ## Good to know
124
133
 
125
134
  - **It spends your API money.** The cost tracking is honest; keep it visible.
126
135
  - **Web-login is experimental and parked.** Driving your paid ChatGPT/Claude/Gemini *web*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "projectinator",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Your AI build team in the terminal — hand it an app idea, a PM model plans a Scrum backlog, and the best model per role designs, codes, and tests it into working files. Bring your own API key.",
5
5
  "type": "module",
6
6
  "private": false,