@harborppm/cli 0.10.0 → 0.10.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 +15 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ Needs Node 22 or later.
|
|
|
12
12
|
|
|
13
13
|
## New to Harbor?
|
|
14
14
|
|
|
15
|
-
You can start from the terminal.
|
|
15
|
+
You can start from the terminal. A harbor of your own is free for 30 days, no card; after that it's $49 a month for the whole crew, not per seat.
|
|
16
16
|
|
|
17
17
|
```sh
|
|
18
18
|
npm install -g @harborppm/cli
|
|
@@ -39,10 +39,24 @@ A task changes in place too: title, status, owner, due date (`2026-10-14`, `toda
|
|
|
39
39
|
|
|
40
40
|
Keys: `↑↓` (or `j k`) and `←→` (or `h l`) move, Enter opens, Esc goes back, `:` finds anything (a screen, "new project", a project or program by name), `/` finds a task by its key or words, `n` makes something new, `e` changes what's open, `[` `]` move a card a column, `x` marks it done, `d` deletes (it asks first), `u` undoes your last change, `H` switches harbor, `?` lists them all.
|
|
41
41
|
|
|
42
|
+
It runs on the same engine as the website: health, task keys, limits and undo work the same way, changes save as you go (the header says when, and holds them while you're offline), and changes anyone makes on the website or elsewhere show up within a couple of seconds. It needs full access, which `harbor login` asks for by name; an older sign-in is asked again the first time.
|
|
43
|
+
|
|
42
44
|
It has colours for dark terminals and for light ones, and picks by asking the terminal for its background (or reading `COLORFGBG`); a terminal that doesn't say gets the dark ones. `harbor theme light` or `harbor theme dark` settles it, `harbor theme auto` goes back to asking, and `HARBOR_THEME` overrides it for one run.
|
|
43
45
|
|
|
44
46
|
`harbor help` shows the mark too, in a terminal with colour; piped, or with `NO_COLOR` set, it's plain text. `harbor --version` says which version you have.
|
|
45
47
|
|
|
48
|
+
## On the website
|
|
49
|
+
|
|
50
|
+
Your harbor is the same one at [harborppm.com](https://harborppm.com/today?utm_source=npm&utm_medium=readme&utm_campaign=cli), signed in with the same account, so the people you work with don't need a terminal. The website adds what a team shares:
|
|
51
|
+
|
|
52
|
+
- **Your crew**: invite people by email under **People**; they see the same boards, risks and roadmap, and their changes reach your terminal within seconds.
|
|
53
|
+
- **Status for others**: the weekly brief, a one-click status report, and read-only links for stakeholders.
|
|
54
|
+
- **Intake forms**: a public form that drops requests onto a project's board.
|
|
55
|
+
- **GitHub**: a pull request that names a task's key (RR-42) shows on the task and moves it along.
|
|
56
|
+
- **Claude and other AI apps**, connected over MCP from [harborppm.com/ai](https://harborppm.com/ai?utm_source=npm&utm_medium=readme&utm_campaign=cli).
|
|
57
|
+
|
|
58
|
+
The website has the commands too: turn on **Command line at the bottom** in your menu, press `/`, and type `mine`, `add "Call the mill" #ridge @sam --due fri` or `done RR-12`.
|
|
59
|
+
|
|
46
60
|
## Staying up to date
|
|
47
61
|
|
|
48
62
|
npm doesn't update a global install by itself, so once a day `harbor` asks npm whether a newer version is out, alongside whatever command you ran, and says so in one line when there is (`npm install -g @harborppm/cli@latest` updates it). It says nothing in scripts, pipes or CI; set `HARBOR_NO_UPDATE_CHECK=1` (or `NO_UPDATE_NOTIFIER=1`) to turn it off.
|
|
@@ -51,8 +65,6 @@ npm doesn't update a global install by itself, so once a day `harbor` asks npm w
|
|
|
51
65
|
|
|
52
66
|
Task titles, names and notes can come from an intake form, a GitHub pull request or anyone in a harbor. Before the commands or the app show them, `harbor` takes out the control characters a terminal would act on (escape sequences, backspaces, text-direction overrides), so a title can't set your clipboard, retitle the window or hide what's around it. `--json` keeps the data exact, with those characters written as `\u` escapes.
|
|
53
67
|
|
|
54
|
-
It runs on the same engine as the website: health, task keys, limits and undo work the same way, changes save as you go (the header says when, and holds them while you're offline), and changes anyone makes on the website or elsewhere show up within a couple of seconds. It needs full access, which `harbor login` asks for by name; an older sign-in is asked again the first time.
|
|
55
|
-
|
|
56
68
|
## Signing in
|
|
57
69
|
|
|
58
70
|
`harbor signup` is for a first visit: the same sign-in, with the page opened on making an account. `harbor login` registers the CLI with Harbor and opens the same page Claude and other apps use: it names "Harbor CLI" and asks what to allow. Choose **Allow reading only** (or run `harbor login --read-only`) if it shouldn't change anything. The sign-in is saved in `~/.config/harbor/credentials.json`, readable only by you, and refreshes itself for 30 days.
|