@ork.so/ork-cli 1.0.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 +33 -0
- package/dist/index.js +4897 -0
- package/package.json +40 -0
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @ork.so/ork-cli
|
|
2
|
+
|
|
3
|
+
Write, search, and manage your [Ork](https://ork.so) notes from the terminal.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g @ork.so/ork-cli # provides the `ork` binary
|
|
7
|
+
# or:
|
|
8
|
+
npx @ork.so/ork-cli --help
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
ork login # sign in via magic link
|
|
13
|
+
ork new -t "First note" -m "Hello from the **terminal**."
|
|
14
|
+
ork ls # list recent notes
|
|
15
|
+
ork search "terminal" # full-text search
|
|
16
|
+
ork view <id> # print a note as Markdown
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Notes are written and read as **Markdown**. Manage tags, collections, publishing,
|
|
20
|
+
and scoped API keys (`ork token …`) for agents/CI.
|
|
21
|
+
|
|
22
|
+
📖 **Full documentation:** https://ork.so/docs/cli
|
|
23
|
+
|
|
24
|
+
## Configuration
|
|
25
|
+
|
|
26
|
+
| Env var | Default | Purpose |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| `ORK_API_URL` | `https://api.ork.so` | API origin (set for a local stack). |
|
|
29
|
+
| `ORK_WEB_URL` | `https://ork.so` | Web origin for printed links. |
|
|
30
|
+
| `ORK_CONFIG_DIR` | `~/.config/ork` | Where the auth token is stored. |
|
|
31
|
+
|
|
32
|
+
Authenticate non-interactively with `ORK_TOKEN` (session) or `ORK_API_KEY`
|
|
33
|
+
(scoped key) in the environment.
|