@osfactory/har 0.3.0 → 0.4.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/README.md +29 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,11 +39,37 @@ npm install && npm run build && npm link
|
|
|
39
39
|
|
|
40
40
|
See [AGENT.md](./AGENT.md) for architecture and coding-agent guidance, and [CONTRIBUTING.md](./CONTRIBUTING.md) for the full development workflow, testing on sample projects, and project layout. To report security issues, see [SECURITY.md](./SECURITY.md).
|
|
41
41
|
|
|
42
|
+
## Harness profiles
|
|
43
|
+
|
|
44
|
+
`har env init` scaffolds `.har/` from a boilerplate profile. Pick the one that matches what agents need to run — you only choose this once at init time.
|
|
45
|
+
|
|
46
|
+
| Profile | Best for | What you get |
|
|
47
|
+
|---------|----------|--------------|
|
|
48
|
+
| `default` | Web apps (Next.js, Rails, Django, etc.) | Docker Compose for shared infra, PM2 for the primary app, per-slot ports and preview URLs |
|
|
49
|
+
| `cli` | CLI tools, libraries, npm packages | No PM2 or port wiring — agents run project commands in an isolated git worktree; optional Docker for databases |
|
|
50
|
+
| `ios` | iOS / Swift mobile apps | xcodebuild + iOS Simulator; configure scheme, project, and simulator in `harness.env` |
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Web app (default — omit --profile)
|
|
54
|
+
cd my-web-app && har env init
|
|
55
|
+
|
|
56
|
+
# CLI tool or library
|
|
57
|
+
cd my-cli && har env init --profile cli
|
|
58
|
+
|
|
59
|
+
# iOS app
|
|
60
|
+
cd MyApp && har env init --profile ios
|
|
61
|
+
har env add-stage rocketsim # optional: UI flow validation on the simulator
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
After init, paste the printed adaptation prompt into your coding agent to tailor scripts to your stack. For built-in Claude adaptation: `har env init --auto` (requires `ANTHROPIC_API_KEY`).
|
|
65
|
+
|
|
66
|
+
Optional stage templates depend on the profile: `har env add-stage playwright` for browser E2E on web apps, `har env add-stage rocketsim` for simulator user-flow checks on iOS.
|
|
67
|
+
|
|
42
68
|
## Quick start
|
|
43
69
|
|
|
44
70
|
```bash
|
|
45
71
|
cd my-app
|
|
46
|
-
har env init
|
|
72
|
+
har env init # or --profile cli / --profile ios
|
|
47
73
|
|
|
48
74
|
# Paste the printed prompt into your coding agent to adapt .har/ and AGENT.md
|
|
49
75
|
git add .har/ AGENT.md
|
|
@@ -55,7 +81,7 @@ har env verify 1
|
|
|
55
81
|
|
|
56
82
|
Shell fallback when the CLI is not installed: `./.har/setup-infra.sh`, `./.har/launch.sh 1`, `./.har/verify.sh 1`.
|
|
57
83
|
|
|
58
|
-
|
|
84
|
+
See [Harness profiles](#harness-profiles) above if your repo is a CLI/library or iOS app rather than a web app.
|
|
59
85
|
|
|
60
86
|
## Repo layout after init
|
|
61
87
|
|
|
@@ -114,7 +140,7 @@ See `.har/stages/PLAYWRIGHT.md` in the target repo after applying the template.
|
|
|
114
140
|
| `har control watch` | Continuously sync registered repos |
|
|
115
141
|
| `har mcp` | Start the HAR MCP server (stdio) |
|
|
116
142
|
|
|
117
|
-
Options: `--force`, `--auto` (built-in Claude adaptation), `--smoke`, `--yes` (auto-apply AGENT.md with `--auto`), `--verbose`, `--profile cli
|
|
143
|
+
Options: `--force`, `--auto` (built-in Claude adaptation), `--smoke`, `--yes` (auto-apply AGENT.md with `--auto`), `--verbose`, `--profile <default|cli|ios>`
|
|
118
144
|
|
|
119
145
|
## MCP Surface
|
|
120
146
|
|