diffmode 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 ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,9 @@
1
+ Diffmode CLI
2
+ Copyright 2026 agentic-builders
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (the "License");
5
+ see the LICENSE file in this distribution, or obtain a copy at:
6
+
7
+ https://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Source repository: https://github.com/agentic-builders/diffmode-cli
package/README.md ADDED
@@ -0,0 +1,215 @@
1
+ # diffmode
2
+
3
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
4
+ [![Node ≥ 20](https://img.shields.io/badge/node-%E2%89%A520-brightgreen.svg)](package.json)
5
+ [![npm version](https://img.shields.io/npm/v/diffmode.svg)](https://www.npmjs.com/package/diffmode)
6
+
7
+ Agent-drivable CLI for the [Diffmode](https://diffmode.app) growth pipeline.
8
+ Thin wrapper around the hosted `/public/v1/*` API: authenticate, submit a
9
+ run, watch a job, retrieve manifest-shaped results.
10
+
11
+ ## Tell your agent
12
+
13
+ > Use the diffmode CLI to generate a growth plan for my product.
14
+
15
+ Most LLM agents (Claude Code, Codex, Cursor) understand that sentence after
16
+ you install the bundled skill (see *Agent integration* below). For one-off
17
+ use, you can also run `diffmode` directly without an agent — it's a plain
18
+ CLI.
19
+
20
+ ## Quick start
21
+
22
+ ```bash
23
+ # 1. Authenticate (paste a PAT from https://diffmode.app/app/tokens)
24
+ npx diffmode@latest login --token dm_pat_…
25
+
26
+ # 2. Run the free-tier diagnostic (1 credit) for your product
27
+ diffmode run my-product --input founder.json
28
+
29
+ # 3. Watch the job until terminal
30
+ diffmode jobs watch <job_id>
31
+
32
+ # 4. Download outputs + emit a manifest
33
+ diffmode results my-product
34
+
35
+ # 5. Optionally unlock the full plan (15 credits)
36
+ diffmode unlock my-product
37
+ ```
38
+
39
+ Top-up is **browser-only by design** — `diffmode` never prompts for a card
40
+ or invokes Stripe. When you run out of credits, the CLI exits with code 8
41
+ and a message pointing to `https://diffmode.app/app/billing`.
42
+
43
+ ## Install
44
+
45
+ ```bash
46
+ # Primary path — no install, always latest
47
+ npx diffmode@latest <command>
48
+
49
+ # Global install (power users)
50
+ npm i -g diffmode
51
+ ```
52
+
53
+ Requires Node ≥ 20.
54
+
55
+ ## Commands overview
56
+
57
+ | Command | What it does | Credits |
58
+ | --- | --- | --- |
59
+ | `diffmode login` / `logout` / `whoami` | PAT-based authentication | — |
60
+ | `diffmode run <product>` | Free-tier diagnostic | 1 |
61
+ | `diffmode unlock <product>` | Full plan (needs prior `run`) | 15 |
62
+ | `diffmode workflow <product>` | Cold-start full workflow | 15 |
63
+ | `diffmode idea-eval <product>` | Score ideas vs. founder context | 5 |
64
+ | `diffmode smoke-test <product>` | Quick tactic smoke-test | 1 |
65
+ | `diffmode jobs list/status/watch/resume/cancel` | Job lifecycle | — |
66
+ | `diffmode results <product>` | Download + manifest | — |
67
+ | `diffmode account` / `billing balance` / `history` | Read-only billing | — |
68
+ | `diffmode limits` | Credits + rate-limit policy | — |
69
+ | `diffmode diagnostics from-url/validate` | Founder-input helpers | — |
70
+ | `diffmode skill show` / `skill install` | Agent skill installer | — |
71
+ | `diffmode commands` | Machine-readable manifest | — |
72
+
73
+ Full per-command reference: [`skills/diffmode/references/commands.md`](skills/diffmode/references/commands.md).
74
+
75
+ Submit commands (`run`, `workflow`, `unlock`, `idea-eval`, `smoke-test`) do a
76
+ pre-flight `GET /billing/balance` before posting and exit 8 if the wallet
77
+ balance is below the module cost. Pass `--no-preflight` to skip it when the
78
+ agent has already verified credits this turn.
79
+
80
+ ## Exit codes
81
+
82
+ | Code | Meaning |
83
+ | --- | --- |
84
+ | `0` | OK |
85
+ | `1` | Generic error |
86
+ | `2` | Usage error (bad flags, missing required input) |
87
+ | `3` | Network |
88
+ | `4` | Auth (invalid/revoked token) |
89
+ | `5` | Conflict (in-flight job for the same product) |
90
+ | `6` | Not found |
91
+ | `7` | Rate-limited (Retry-After) |
92
+ | `8` | Insufficient credits (top up via the browser) |
93
+ | `9` | Server (5xx) |
94
+ | `10` | Interrupted but resumable (`diffmode jobs resume`) |
95
+ | `130` | SIGINT (Ctrl-C; never cancels the server-side job) |
96
+
97
+ Full per-code recovery guidance: [`skills/diffmode/references/error-codes.md`](skills/diffmode/references/error-codes.md).
98
+
99
+ ## Agent integration
100
+
101
+ `diffmode` ships an Anthropic-format skill (`SKILL.md`), an `AGENTS.md`
102
+ companion, an `llms.txt`, and a Cursor MDC rule — all generated from one
103
+ source so they don't drift.
104
+
105
+ Install them into your agent's known location:
106
+
107
+ ```bash
108
+ # Install into Claude Code, Codex, and Cursor (default)
109
+ diffmode skill install
110
+
111
+ # Or pick a target
112
+ diffmode skill install --target claude
113
+ diffmode skill install --target cursor
114
+
115
+ # Inspect what would happen first
116
+ diffmode skill install --dry-run
117
+ diffmode skill install --print-paths
118
+ ```
119
+
120
+ Default destinations:
121
+
122
+ | Target | Path |
123
+ | --- | --- |
124
+ | Claude Code | `~/.claude/skills/diffmode/SKILL.md` |
125
+ | Codex | `~/.codex/skills/diffmode/SKILL.md` |
126
+ | Cursor | `~/.cursor/rules/diffmode.mdc` |
127
+
128
+ Override with the env vars `DIFFMODE_SKILL_CLAUDE_PATH`,
129
+ `DIFFMODE_SKILL_CODEX_PATH`, `DIFFMODE_SKILL_CURSOR_PATH`.
130
+
131
+ To preview the skill text without installing: `diffmode skill show`.
132
+
133
+ ## Configuration
134
+
135
+ `diffmode` reads configuration in this order:
136
+
137
+ 1. Per-command flag (e.g., `--token`, `--timeout`, `--profile`)
138
+ 2. Environment variable
139
+ 3. Built-in defaults
140
+
141
+ A `~/.config/diffmode/config.json` profile registry is planned for Phase 2;
142
+ 0.1.0 only reads the env vars below.
143
+
144
+ ### Environment variables
145
+
146
+ | Variable | Purpose | Default |
147
+ | --- | --- | --- |
148
+ | `DIFFMODE_TOKEN` | PAT (overrides stored, beaten by `--token`) | — |
149
+ | `DIFFMODE_API_BASE` | API base URL | `https://ai-cmo-api.onrender.com/public/v1` |
150
+ | `DIFFMODE_BILLING_URL` | Billing redirect URL | `https://diffmode.app/app/billing` |
151
+ | `DIFFMODE_PROFILE` | Active profile name (overridden by `--profile`) | `default` |
152
+ | `DIFFMODE_SKILL_CLAUDE_PATH` | Override Claude skill install target | `~/.claude/skills/diffmode/SKILL.md` |
153
+ | `DIFFMODE_SKILL_CODEX_PATH` | Override Codex skill install target | `~/.codex/skills/diffmode/SKILL.md` |
154
+ | `DIFFMODE_SKILL_CURSOR_PATH` | Override Cursor MDC install target | `~/.cursor/rules/diffmode.mdc` |
155
+ | `NO_COLOR=1` | Disable ANSI colors | — |
156
+
157
+ The active profile is used as the keyring account name, so different
158
+ profiles can hold independent PATs (`diffmode --profile staging login …`).
159
+
160
+ Tokens are stored separately in the OS keyring (`keytar`) — or in a
161
+ mode-`0600` fallback file with a one-time stderr warning when the keyring
162
+ isn't available.
163
+
164
+ ## JSON output contract
165
+
166
+ Every command emits JSON when stdout is not a TTY (or when `--json` is set).
167
+ The envelope is schema-versioned:
168
+
169
+ > **Cat-style exception:** `diffmode results --show <path>` and `diffmode
170
+ > skill show` stream raw file/markdown contents to stdout by default so
171
+ > `diffmode skill show > SKILL.md` and `diffmode results <p> --show <path>
172
+ > > out.md` work as documented. Pass `--json` explicitly to get the
173
+ > `{path, contents}` envelope on these two read-out commands; on `--show`
174
+ > the envelope also carries `truncated: true` when `--max-tokens` clipped
175
+ > the body.
176
+
177
+ ```json
178
+ { "schema_version": "1", "job_id": "…", "status": "running" }
179
+ ```
180
+
181
+ Errors go to **stderr** with the same envelope shape:
182
+
183
+ ```json
184
+ { "error": { "code": "auth", "message": "…", "retryable": false } }
185
+ ```
186
+
187
+ For agent self-discovery, run `diffmode commands` — it dumps the full
188
+ commander tree as a stable, machine-readable manifest.
189
+
190
+ ## Idempotency
191
+
192
+ `Idempotency-Key` is the agent's responsibility (matches `gh` / `stripe`
193
+ conventions). Generate a UUIDv4 and pass `--idempotency-key <uuid>` on each
194
+ submit (`run`, `workflow`, `unlock`, `idea-eval`, `smoke-test`). Same key +
195
+ same user → same `job_id` back (no double-charge). The CLI never
196
+ auto-generates the key.
197
+
198
+ ## Security
199
+
200
+ - The CLI **never logs the `Authorization` header value**, even with
201
+ `--verbose` (redacted to `Bearer ***`).
202
+ - `login` reads a PAT from stdin or `--token` but never echoes it back.
203
+ - The mode-`0600` credential file fallback is only used when the OS keyring
204
+ is unavailable; the CLI prints a one-time stderr warning when it falls
205
+ back.
206
+
207
+ Report security issues per [`SECURITY.md`](SECURITY.md).
208
+
209
+ ## Contributing
210
+
211
+ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
212
+
213
+ ## License
214
+
215
+ Apache-2.0. See [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE).