@orbit-app/cli 0.0.0-stage → 1.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/README.md +30 -2
- package/dist/cli.mjs +7079 -0
- package/dist/orbit.mjs +7 -0
- package/package.json +32 -4
package/README.md
CHANGED
|
@@ -1,3 +1,31 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @orbit-app/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `orbit` command publishes Mac apps and web apps to an Orbit store. It needs Node.js 22 or later, on macOS or Linux.
|
|
4
|
+
|
|
5
|
+
Run a command with no install:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @orbit-app/cli login
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or install it once, then type `orbit`:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install --global @orbit-app/cli
|
|
15
|
+
orbit login
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
| Command | macOS | Linux |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| `login`, `logout`, `whoami` | Yes | Yes |
|
|
21
|
+
| `publish`, `pack` of a web app | Yes | Yes |
|
|
22
|
+
| `publish`, `pack` of a Mac app | Yes | No: a Mac app is signed on a Mac |
|
|
23
|
+
| `yank`, `types`, `functions logs`, `functions runs` | Yes | Yes |
|
|
24
|
+
| `web dev`, `dev-schema`, `functions dev`, `functions connect` | Yes | No: these open Orbit.app |
|
|
25
|
+
| `preview mcp` | Yes | No: each tool answers that it needs Orbit.app |
|
|
26
|
+
|
|
27
|
+
The sign-in is in the login keychain on macOS. On Linux it is in the Secret Service when `secret-tool` works, else in `$XDG_CONFIG_HOME/orbit/credentials.json` (default `~/.config/orbit/credentials.json`) with mode 600. `ORBIT_API_KEY` overrides both, for CI.
|
|
28
|
+
|
|
29
|
+
`--api <URL>` or `ORBIT_API_URL` picks the API. The default is `https://api.orbitapp.store`. Run `orbit --help` or `orbit <command> --help` for every option.
|
|
30
|
+
|
|
31
|
+
The npm package `orbit` also installs an `orbit` command. If both are installed globally, `orbit` runs the one that npm linked last.
|