gigabuddy 0.2.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.
Files changed (5) hide show
  1. package/README.md +37 -38
  2. package/bin/cli.js +63 -14716
  3. package/index.js +55 -14647
  4. package/package.json +2 -2
  5. package/src/lib/commands.d.ts +17 -1
package/README.md CHANGED
@@ -1,63 +1,62 @@
1
1
  # gigabuddy
2
2
 
3
- The Gigabuddy CLI. Sign in, and install `@gigabuddy` packages as yourself.
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 # or: npx gigabuddy login --npm
10
+ npm install -g gigabuddy
11
+ # or run without installing:
12
+ npx gigabuddy login
13
+ ```
14
+
15
+ ## Usage
7
16
 
8
- gigabuddy login --npm
17
+ ```bash
18
+ gigabuddy login
9
19
  npm install @gigabuddy/app-kit
10
20
  ```
11
21
 
12
- That's the whole onboarding. `login --npm` signs you in if you haven't already,
13
- so there is no two-step dance.
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 | What it does |
18
- | ----------------------- | --------------------------------------------------------- |
19
- | `gigabuddy login` | Sign in (device flow — opens your browser) |
20
- | `gigabuddy login --npm` | Set up `~/.npmrc` to install `@gigabuddy` packages as you |
21
- | `gigabuddy status` | Who you're signed in as |
22
- | `gigabuddy logout` | Sign out (`--npm` clears only the npm credential) |
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
- `--staging` targets the staging environment; its credentials are stored
25
- separately, so a staging login never becomes your production one.
35
+ **Options:** `--no-npm` signs in without modifying `~/.npmrc`. `--staging`
36
+ targets the staging environment; staging credentials are stored separately.
26
37
 
27
- ## What lands on disk
38
+ ## Credentials
28
39
 
29
- `login` stores a **refresh token** in `~/.gigabuddy/user-credentials.json`
30
- (0600). Platform tokens are minted from it on demand and live an hour. The
31
- session behind it is deliberately narrow — it identifies you, lets you see what
32
- you can reach, install from the Gigabuddy registry, and run agents you sponsor;
33
- it is not your full account authority.
40
+ `login` writes a refresh token to `~/.gigabuddy/user-credentials.json` (mode
41
+ 0600). Short-lived platform tokens are minted from it on demand.
34
42
 
35
- `login --npm` adds two lines to `~/.npmrc` (0600), leaving everything else in
36
- that file exactly where it was:
43
+ It also adds two lines to `~/.npmrc` (0600), leaving the rest of the file
44
+ untouched:
37
45
 
38
46
  ```
39
47
  @gigabuddy:registry=https://npm.gigabuddy.com/
40
48
  //npm.gigabuddy.com/:_authToken=<registry credential>
41
49
  ```
42
50
 
43
- **That credential is registry-scoped.** It can install what you can install and
44
- nothing else on the platform — because `.npmrc` is a file that ends up in CI
45
- logs and is readable by every postinstall script that runs on your machine. It
46
- lives 30 days (npm has nowhere to put a token refresh), and it dies with your
47
- session: signing out, or an admin revoking the session, stops installs within
48
- about a minute. Re-run `gigabuddy login --npm` to get a fresh one.
49
-
50
- Which packages you can install is decided per install, against your own access —
51
- the credential only proves who you are.
52
-
53
- ## 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.
54
55
 
55
- This CLI does authentication and local setup, and nothing else. Gigabuddy's
56
- capabilities live behind hosted APIs; this is how you prove who you are to them.
56
+ ## Requirements
57
57
 
58
- Requires Node 20+. No dependencies.
58
+ Node 20 or later. No dependencies.
59
59
 
60
- ---
60
+ ## License
61
61
 
62
- Internal notes for maintainers live in `NOTES.md` in the source repo — they are
63
- deliberately not shipped in this package.
62
+ MIT