background-agents 1.0.2 → 1.0.5
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 +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,14 +8,14 @@ npx background-agents@latest
|
|
|
8
8
|
|
|
9
9
|
That's it. The first run downloads the Electron runtime (~once, then cached); every run loads the production app at <https://backgrounder.dev>.
|
|
10
10
|
|
|
11
|
-
> **Naming:** the TypeScript SDK previously published as `background-agents` now lives at [`@background-agents/sdk`](../
|
|
11
|
+
> **Naming:** the TypeScript SDK previously published as `background-agents` now lives at [`@background-agents/sdk`](../sdk), which freed the `background-agents` name for this desktop launcher.
|
|
12
12
|
|
|
13
13
|
## How it works
|
|
14
14
|
|
|
15
15
|
This is a thin launcher published to npm as [`background-agents`](https://www.npmjs.com/package/background-agents):
|
|
16
16
|
|
|
17
17
|
1. `npx background-agents@latest` resolves the **latest published version** of this package from the npm registry.
|
|
18
|
-
2. npm installs it and its
|
|
18
|
+
2. npm installs it and its dependencies — **Electron** (plus `electron-updater` and `isomorphic-git`) — downloading the Electron platform binary on first run (cached for later runs).
|
|
19
19
|
3. The launcher spawns the bundled Electron app (`app/`) pointed at the production backend, showing a small terminal UI while it starts.
|
|
20
20
|
|
|
21
21
|
Because every launch pulls the latest npm version, **publishing a new version is the update mechanism** — there's no separate auto-updater to configure or code-sign.
|
|
@@ -46,7 +46,7 @@ Environment variable `BACKGROUND_AGENTS_URL` does the same as `--url` (the flag
|
|
|
46
46
|
|
|
47
47
|
## Development
|
|
48
48
|
|
|
49
|
-
This package lives in the monorepo at `packages/launcher`. Its `app/` directory is generated — it's a copy of the compiled `@background-agents/
|
|
49
|
+
This package lives in the monorepo at `packages/launcher`. Its `app/` directory is generated — it's a copy of the compiled `@background-agents/desktop` output.
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
52
|
# From the repo root:
|
|
@@ -71,7 +71,7 @@ Pushing a `v*` tag runs the publish workflow, which sets the package version fro
|
|
|
71
71
|
git tag v1.0.1 && git push origin v1.0.1
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
> The workflow
|
|
74
|
+
> The workflow lives at `.github/workflows/npm-publish.yml` and is active. The Electron desktop installers are built by a separate workflow, `release-workflow.yml`, which currently sits at `.github/release-workflow.yml` — **outside** `.github/workflows/` — so it does **not** run on a tag push until it's moved into `.github/workflows/` (see the [desktop README](../desktop/README.md#automated-releases-github-actions)). Once moved, the same `v*` tag publishes the desktop installers and the npm launcher together.
|
|
75
75
|
|
|
76
76
|
### Manual
|
|
77
77
|
|
package/package.json
CHANGED