gigabuddy 0.3.0 → 0.3.1
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 +36 -40
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,66 +1,62 @@
|
|
|
1
1
|
# gigabuddy
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Command-line sign-in for the [Gigabuddy](https://gigabuddy.com) platform.
|
|
4
|
+
Authenticates your machine and configures npm to install `@gigabuddy`
|
|
5
|
+
packages from the Gigabuddy registry.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
4
8
|
|
|
5
9
|
```bash
|
|
6
|
-
npm install -g gigabuddy
|
|
10
|
+
npm install -g gigabuddy
|
|
11
|
+
# or run without installing:
|
|
12
|
+
npx gigabuddy login
|
|
13
|
+
```
|
|
7
14
|
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```bash
|
|
8
18
|
gigabuddy login
|
|
9
19
|
npm install @gigabuddy/app-kit
|
|
10
20
|
```
|
|
11
21
|
|
|
12
|
-
|
|
13
|
-
|
|
22
|
+
`login` opens your browser to sign in (device flow), stores your credential,
|
|
23
|
+
and configures `~/.npmrc` for the `@gigabuddy` registry.
|
|
14
24
|
|
|
15
25
|
## Commands
|
|
16
26
|
|
|
17
|
-
| Command
|
|
18
|
-
|
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
27
|
+
| Command | Description |
|
|
28
|
+
| ------------------ | -------------------------------------------------------------- |
|
|
29
|
+
| `login` | Sign in and configure `~/.npmrc` for the `@gigabuddy` registry |
|
|
30
|
+
| `login --npm` | Refresh only the npm registry credential |
|
|
31
|
+
| `status` | Show the signed-in account |
|
|
32
|
+
| `doctor [package]` | Diagnose sign-in, npm config, and registry access |
|
|
33
|
+
| `logout` | Sign out (`--npm` removes only the npm credential) |
|
|
23
34
|
|
|
24
|
-
|
|
35
|
+
**Options:** `--no-npm` signs in without modifying `~/.npmrc`. `--staging`
|
|
36
|
+
targets the staging environment; staging credentials are stored separately.
|
|
25
37
|
|
|
26
|
-
|
|
27
|
-
separately, so a staging login never becomes your production one.
|
|
38
|
+
## Credentials
|
|
28
39
|
|
|
29
|
-
|
|
40
|
+
`login` writes a refresh token to `~/.gigabuddy/user-credentials.json` (mode
|
|
41
|
+
0600). Short-lived platform tokens are minted from it on demand.
|
|
30
42
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
session behind it is deliberately narrow — it identifies you, lets you see what
|
|
34
|
-
you can reach, install from the Gigabuddy registry, and run agents you sponsor;
|
|
35
|
-
it is not your full account authority.
|
|
36
|
-
|
|
37
|
-
`login` also adds two lines to `~/.npmrc` (0600), leaving everything else in
|
|
38
|
-
that file exactly where it was:
|
|
43
|
+
It also adds two lines to `~/.npmrc` (0600), leaving the rest of the file
|
|
44
|
+
untouched:
|
|
39
45
|
|
|
40
46
|
```
|
|
41
47
|
@gigabuddy:registry=https://npm.gigabuddy.com/
|
|
42
48
|
//npm.gigabuddy.com/:_authToken=<registry credential>
|
|
43
49
|
```
|
|
44
50
|
|
|
45
|
-
|
|
46
|
-
nothing else
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
session: signing out, or an admin revoking the session, stops installs within
|
|
50
|
-
about a minute. Re-run `gigabuddy login --npm` to get a fresh one without
|
|
51
|
-
another browser round-trip.
|
|
52
|
-
|
|
53
|
-
Which packages you can install is decided per install, against your own access —
|
|
54
|
-
the credential only proves who you are.
|
|
55
|
-
|
|
56
|
-
## Scope
|
|
51
|
+
The npm credential is registry-scoped: it authorizes package installs and
|
|
52
|
+
nothing else. It expires after 30 days and is revoked when you sign out;
|
|
53
|
+
refresh it with `gigabuddy login --npm`. Package access is checked per
|
|
54
|
+
install against your account.
|
|
57
55
|
|
|
58
|
-
|
|
59
|
-
capabilities live behind hosted APIs; this is how you prove who you are to them.
|
|
56
|
+
## Requirements
|
|
60
57
|
|
|
61
|
-
|
|
58
|
+
Node 20 or later. No dependencies.
|
|
62
59
|
|
|
63
|
-
|
|
60
|
+
## License
|
|
64
61
|
|
|
65
|
-
|
|
66
|
-
deliberately not shipped in this package.
|
|
62
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gigabuddy",
|
|
3
|
-
"version": "0.3.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.3.1",
|
|
4
|
+
"description": "Command-line sign-in for Gigabuddy. Authenticates your machine and configures npm for @gigabuddy packages.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"homepage": "https://gigabuddy.com",
|