harnesstap 0.0.0 → 1.0.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 2026 HarnessTap Contributors
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/README.md ADDED
@@ -0,0 +1,306 @@
1
+ <div align="center">
2
+
3
+ <h1>
4
+ <img src="docs/assets/harnesstap-lockup.svg" alt="HarnessTap" width="320" />
5
+ </h1>
6
+
7
+ **One setup. Every coding agent.**
8
+
9
+ Scan existing setup → store canonical resources → compose **plugins** → share offline or via catalog → materialize into any supported harness.
10
+
11
+ Use the **CLI** (`ht`) or **Desktop** — both talk to the same local library at `~/.harnesstap`.
12
+
13
+ <br />
14
+
15
+ [![CI](https://github.com/harnesstap/harnesstap/actions/workflows/ci.yml/badge.svg)](https://github.com/harnesstap/harnesstap/actions/workflows/ci.yml)
16
+ [![License](https://img.shields.io/github/license/harnesstap/harnesstap)](LICENSE)
17
+ [![npm](https://img.shields.io/npm/v/harnesstap?color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/harnesstap)
18
+ [![Node](https://img.shields.io/badge/node-%3E%3D20-339933?logo=node.js&logoColor=white)](https://nodejs.org)
19
+
20
+ <br />
21
+
22
+ [Install](#install) · [Quick start](#quick-start) · [Desktop](#desktop) · [Demo](#demo) · [Supported harnesses](docs/supported-harnesses.md) · [CLI reference](docs/cli/command-reference.md)
23
+
24
+ <br />
25
+
26
+ ![HarnessTap feature map](docs/assets/harnesstap-features.svg)
27
+
28
+ </div>
29
+
30
+ ---
31
+
32
+ ## Table of contents
33
+
34
+ - [Features](#features)
35
+ - [Install](#install)
36
+ - [Quick start](#quick-start)
37
+ - [Desktop](#desktop)
38
+ - [Demo](#demo)
39
+ - [Concept model](#concept-model)
40
+ - [Catalog and Cloud](#catalog-and-cloud)
41
+ - [Supported harnesses](#supported-harnesses)
42
+ - [Where data lives](#where-data-lives)
43
+ - [Next steps](#next-steps)
44
+
45
+ ---
46
+
47
+ ## Features
48
+
49
+ `harnesstap` keeps assistant configuration in one place and writes the files each harness expects.
50
+
51
+ | Capability | What it does |
52
+ | --- | --- |
53
+ | **Scan & import** | Detect Claude Code, Codex, Cursor, Copilot, Goose, and other project or home layouts |
54
+ | **Canonical library** | Store imported configuration as resources in local SQLite |
55
+ | **Plugins** | Group resources into versioned plugins with dependencies and environments |
56
+ | **Profiles** | Switch a machine-wide setup (`ht profile use work` or `ht work`) |
57
+ | **Multi-harness apply** | Materialize a plugin to a project or to home paths, with environment cascade |
58
+ | **Snapshots & drift** | Snapshot tracked projects before apply, inspect drift, revert when needed |
59
+ | **Cloud catalog** | Search, pull, and publish shared plugins through HarnessTap Cloud |
60
+ | **Machine transfer** | Export the local library and harness preferences for another machine |
61
+ | **Desktop** | Browse plugins, profiles, and apply from a local app that shares the CLI library |
62
+
63
+ **42 harnesses** are registered today. Native serializers: Claude Code, Cursor, Codex, Goose, OpenCode, GitHub Copilot, Copilot CLI, Gemini CLI, Grok Build, DeepSeek Harness. The rest use a path-driven serializer. Full matrix: [Supported harnesses](docs/supported-harnesses.md).
64
+
65
+ ---
66
+
67
+ ## Install
68
+
69
+ **Requirements:** Node.js 20+ to run the published CLI.
70
+
71
+ ### Recommended: npx (no global install)
72
+
73
+ ```bash
74
+ npx harnesstap@latest init
75
+ ```
76
+
77
+ ### npm global
78
+
79
+ ```bash
80
+ npm install -g harnesstap
81
+ ht init
82
+ ```
83
+
84
+ `ht` is shorthand for `harnesstap`.
85
+
86
+ <details>
87
+ <summary><strong>Bun</strong> (alternative)</summary>
88
+
89
+ ```bash
90
+ bun install -g harnesstap
91
+ ht init
92
+ ```
93
+
94
+ Or without a global install: `bunx harnesstap@latest init`.
95
+
96
+ </details>
97
+
98
+ <details>
99
+ <summary><strong>Install from source</strong></summary>
100
+
101
+ ```bash
102
+ git clone https://github.com/harnesstap/harnesstap.git
103
+ cd harnesstap
104
+ bun install
105
+ bun run link
106
+ ht init
107
+ ```
108
+
109
+ `bun run link` builds the CLI and registers `harnesstap` and `ht`. If your shell cannot find them, add Bun's global bin directory to `PATH`:
110
+
111
+ ```bash
112
+ export PATH="$HOME/.bun/bin:$PATH"
113
+ ```
114
+
115
+ </details>
116
+
117
+ ---
118
+
119
+ ## Quick start
120
+
121
+ Two common paths: adopt an existing repo, or switch your **home** harness setup with a profile.
122
+
123
+ ### Project: onboard from `apm.yml`
124
+
125
+ ```bash
126
+ ht install
127
+ ```
128
+
129
+ Default onboarding in a repo that already has `apm.yml`. Same loop as `ht apply` with no plugin selector. Registry identities in `dependencies.mcp` (for example `io.github.github/github-mcp-server`) resolve from the official MCP Registry into the same native MCP files HT already emits. Pin `targets:` so install/compile do not follow whichever tool folders exist on the current machine. Preview with `ht targets`; `ht compile` is the same apply-from-manifest loop under a named entry. Commit `apm.lock.yaml` plus the generated harness output (`.claude/`, `.cursor/`, `AGENTS.md`, and so on). See [Install a project](docs/cli/use/install.md).
130
+
131
+ ### Project: scan and apply
132
+
133
+ ```bash
134
+ ht init --main codex --aliases claude-code,cursor
135
+ ht scan .
136
+ ht resource list
137
+ ht apply engineering-foundation --project .
138
+ ht status .
139
+ ```
140
+
141
+ `ht apply engineering-foundation` resolves the public catalog when the plugin is not already local. When the repository has a git `origin`, apply stores a snapshot first; restore with `ht revert`.
142
+
143
+ ### Machine: profile switch
144
+
145
+ ```bash
146
+ ht init --main claude-code --aliases cursor,codex
147
+ ht profile use "global default"
148
+ # after you compose a `work` profile:
149
+ ht work
150
+ ```
151
+
152
+ `init` seeds a `global default` profile plugin. It does **not** write home harness files until you run `profile use` (or the `ht <name>` shorthand; `ht default` still resolves to `global default`).
153
+
154
+ More install and follow-up recipes: [Getting started](docs/cli/getting-started.md).
155
+
156
+ ---
157
+
158
+ ## Desktop
159
+
160
+ HarnessTap Desktop is a local app for the same library the CLI uses. Browse plugins and profiles, preview conflicts, and apply without leaving the GUI.
161
+
162
+ It is **not** in the npm package. Download installers from [GitHub Releases](https://github.com/harnesstap/harnesstap/releases):
163
+
164
+ - **macOS:** `.dmg` for Apple Silicon (`aarch64`) and Intel (`x64`)
165
+ - **Windows:** NSIS (`.exe`) and MSI for x64 and arm64
166
+ - **Linux:** `.AppImage`, `.deb`, and `.rpm` for x64 and arm64 (built on Ubuntu 22.04 so glibc stays compatible with Ubuntu 22.04 / Debian 12). GitHub Releases attach all three; the Linux job fails if AppImage is missing.
167
+
168
+ Builds are unsigned (no Apple notarization, Windows Authenticode, or Linux package signing). macOS Gatekeeper may require **Open Anyway** under System Settings → Privacy & Security; Windows SmartScreen may warn on first launch.
169
+
170
+ To build from this repo:
171
+
172
+ ```bash
173
+ bun run desktop:dev # development
174
+ bun run desktop:build # packaged app under apps/desktop/src-tauri/target/release/bundle/
175
+ bun run desktop:install # build + install HarnessTap.app into /Applications
176
+ ```
177
+
178
+ Details, sidecar notes, and e2e: [apps/desktop/README.md](apps/desktop/README.md).
179
+
180
+ ---
181
+
182
+ ## Demo
183
+
184
+ Initialise HarnessTap, scan an existing repository, browse catalog plugins, apply one, and confirm the final state — all in about a minute.
185
+
186
+ [![Existing repo adoption walkthrough](docs/scenarios/vhs/output/01-existing-repo-adoption.gif)](docs/scenarios/vhs/walkthroughs/01-existing-repo-adoption.md)
187
+
188
+ [Full walkthrough →](docs/scenarios/vhs/walkthroughs/01-existing-repo-adoption.md)
189
+
190
+ ```bash
191
+ ht init --main codex --aliases claude-code,cursor
192
+ ht scan . # detect existing resources
193
+ ht resource list # review discovered resources
194
+ ht plugin list --search foundation --remote-only
195
+ ht apply engineering-foundation --project .
196
+ ht status . # confirm the final state
197
+ ```
198
+
199
+ ---
200
+
201
+ ## Concept model
202
+
203
+ HarnessTap keeps one library of **resources** — skills, rules, MCP servers, hooks, agents, commands. You group them into **plugins**. `ht apply <plugin>` (project) or `ht profile use <plugin>` (home) resolves the dependency graph and writes harness files. When two plugins disagree, the one closest to what you applied wins; genuine ambiguity is an error you fix with an override. An **environment** fills in the values a plugin needs — model, permissions, tokens by reference. Secrets are never stored in a plugin.
204
+
205
+ | Concept | Role |
206
+ | --- | --- |
207
+ | **Resource** | Atomic instruction, skill, rule, MCP, hook, etc. |
208
+ | **Plugin** | Versioned package of resources, optional dependencies, and a `needs` contract |
209
+ | **Environment** | Named *how* values (and secret refs) — prod, staging, personal |
210
+ | **Profile** | A plugin tagged for machine-wide switching (`ht work`, `profile use`) |
211
+ | **Workspace** | Local library at `~/.harnesstap` |
212
+
213
+ **Cascade (last wins):** nearer plugins override farther ones; `home env ◂ plugin default env` for environment values.
214
+
215
+ ```mermaid
216
+ flowchart TB
217
+ subgraph Sources[Configuration sources]
218
+ Home[Home defaults]
219
+ Repo[Existing project files]
220
+ Cloud[HarnessTap Cloud plugins]
221
+ end
222
+
223
+ subgraph Library[Local HarnessTap library]
224
+ Resources[Canonical resources in SQLite]
225
+ Plugins[Plugins]
226
+ Envs[Environments]
227
+ Profiles[Profiles]
228
+ end
229
+
230
+ subgraph Surfaces[How you work]
231
+ CLI[ht CLI]
232
+ Desktop[Desktop app]
233
+ end
234
+
235
+ subgraph Targets[Materialized harnesses]
236
+ Project[Project files]
237
+ Global[Home harness paths]
238
+ end
239
+
240
+ Home --> Resources
241
+ Repo --> Resources
242
+ Cloud --> Plugins
243
+ Resources --> Plugins
244
+ Envs --> Plugins
245
+ Plugins --> Profiles
246
+ CLI --> Plugins
247
+ Desktop --> Plugins
248
+ Plugins --> Project
249
+ Profiles --> Global
250
+ ```
251
+
252
+ ---
253
+
254
+ ## Catalog and Cloud
255
+
256
+ Starter plugins such as `engineering-foundation` live in the **HarnessTap Cloud** public catalog — not inside the npm package. Bare names on `ht apply` resolve against that catalog (and any orgs you have connected).
257
+
258
+ ```bash
259
+ ht plugin list --search foundation --remote-only
260
+ ht apply engineering-foundation
261
+ ht auth login
262
+ ht plugin pull acme/library
263
+ ht plugin catalog register acme/default
264
+ ht plugin publish my-setup
265
+ ```
266
+
267
+ To opt out of anonymous public catalog lookups, set `catalog.publicCatalog: false` in `~/.harnesstap/config.jsonc` or export `HARNESSTAP_PUBLIC_CATALOG=0`.
268
+
269
+ Auth, orgs, pull, and publish: [HarnessTap Cloud](docs/cli/cloud.md).
270
+
271
+ ---
272
+
273
+ ## Supported harnesses
274
+
275
+ ```bash
276
+ ht harness list
277
+ ht harness list --supported # native serializers only
278
+ ht harness set --main claude-code --aliases cursor,codex
279
+ ```
280
+
281
+ See the full matrix — resource types, skill emission, plugin support, and paths — in **[Supported harnesses](docs/supported-harnesses.md)**.
282
+
283
+ ---
284
+
285
+ ## Where data lives
286
+
287
+ Operational state lives in `~/.harnesstap/harnesstap.db` (resources, plugins, environments, profiles, tracked projects, snapshots, harness preferences). Optional settings live in `~/.harnesstap/config.jsonc`. Cloud accounts: `~/.harnesstap/cloud-accounts.json`.
288
+
289
+ Override the base directory with `HARNESSTAP_HOME`.
290
+
291
+ `ht init` also checks registered home folders (e.g. `~/.claude/`, `~/.codex/`) and imports supported resources it finds.
292
+
293
+ Move a library between machines with `ht migrate export` / `import`. Older databases that cannot upgrade in place still open read-only for export — see [machine migration](docs/scenarios/details/28-machine-migration.md).
294
+
295
+ ---
296
+
297
+ ## Next steps
298
+
299
+ | I want to… | Start here |
300
+ | --- | --- |
301
+ | Learn every command | [CLI reference](docs/cli/command-reference.md) |
302
+ | Compose, doctor, or diff plugins | [Plugin concepts](docs/cli/concepts/plugins.md) · `ht plugin doctor` · `ht plugin from-project` |
303
+ | Sync marketplace pins | `ht plugin edit my-setup --add plugin:formatter@my-marketplace --version "^2.1.0"` |
304
+ | Add a scanned skill | `ht plugin edit my-setup --add research-helper --type skill` |
305
+ | Check project drift | `ht status . --check` · `ht mirror .` |
306
+ | Contribute | [CONTRIBUTING.md](CONTRIBUTING.md) |
@@ -0,0 +1,7 @@
1
+ import { Command } from 'commander';
2
+
3
+ declare const program: Command;
4
+
5
+ declare function runHarnesstapCli(argv?: string[]): Promise<void>;
6
+
7
+ export { program, runHarnesstapCli };