artyfax 0.2.3 → 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 (3) hide show
  1. package/README.md +69 -36
  2. package/dist/cli.js +1847 -269
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -10,6 +10,8 @@ npm install -g artyfax
10
10
 
11
11
  Requires Node.js 20 or later.
12
12
 
13
+ The command is `artyfax`. If you prefer brevity, `arty` and `ax` are built-in aliases for the same command - use whichever you like.
14
+
13
15
  ## Quick start
14
16
 
15
17
  ```bash
@@ -17,16 +19,16 @@ Requires Node.js 20 or later.
17
19
  export ARTYFAX_API_KEY="your-api-key"
18
20
 
19
21
  # Save a document
20
- arty save notes.md --category inbox
22
+ artyfax save notes.md --category inbox
21
23
 
22
24
  # List your documents
23
- arty list
25
+ artyfax list
24
26
 
25
27
  # Search your library
26
- arty search "deployment guide"
28
+ artyfax search "deployment guide"
27
29
 
28
30
  # Check your setup
29
- arty doctor
31
+ artyfax doctor
30
32
  ```
31
33
 
32
34
  ## Commands
@@ -35,50 +37,81 @@ arty doctor
35
37
 
36
38
  | Command | Description |
37
39
  |---------|-------------|
38
- | `arty save <file>` | Save a document (markdown or HTML) |
39
- | `arty save --url <url>` | Save from a URL (server-side extraction) |
40
- | `arty read <slug>` | Read document content (handles E2EE decryption) |
41
- | `arty list` | List documents |
42
- | `arty get <slug>` | Document metadata as JSON |
43
- | `arty search <query>` | Full-text search |
44
- | `arty update <slug> <file>` | Push updated content (auto-encrypts secure docs) |
45
- | `arty metadata <slug>` | Update document metadata |
46
- | `arty delete <slug>` | Delete a document |
47
- | `arty open <slug>` | Open document in browser |
48
- | `arty secure <slug>` | Encrypt a document |
49
- | `arty unsecure <slug>` | Remove encryption |
40
+ | `artyfax save <file>` | Save a document (markdown or HTML) |
41
+ | `artyfax save --url <url>` | Save from a URL (server-side extraction) |
42
+ | `artyfax read <slug>` | Read document content (handles E2EE decryption) |
43
+ | `artyfax list` | List documents |
44
+ | `artyfax get <slug>` | Document metadata as JSON |
45
+ | `artyfax search <query>` | Full-text search |
46
+ | `artyfax update <slug> <file>` | Push updated content (auto-encrypts secure docs) |
47
+ | `artyfax metadata <slug>` | Update document metadata |
48
+ | `artyfax delete <slug>` | Delete a document |
49
+ | `artyfax open <slug>` | Open document in browser |
50
+ | `artyfax secure <slug>` | Encrypt a document |
51
+ | `artyfax unsecure <slug>` | Remove encryption |
50
52
 
51
53
  ### Shares
52
54
 
53
55
  | Command | Description |
54
56
  |---------|-------------|
55
- | `arty share create <slug>` | Create a share link |
56
- | `arty share list [slug]` | List shares |
57
- | `arty share revoke <hash>` | Revoke a share link |
57
+ | `artyfax share create <slug>` | Create a share link |
58
+ | `artyfax share list [slug]` | List shares |
59
+ | `artyfax share revoke <hash>` | Revoke a share link |
58
60
 
59
61
  ### Sub-resources
60
62
 
61
63
  | Command | Description |
62
64
  |---------|-------------|
63
- | `arty cat list` | List categories with document counts |
64
- | `arty tag list` | List tags with counts |
65
- | `arty version list <slug>` | Version history |
66
- | `arty version restore <slug>` | Restore a previous version |
65
+ | `artyfax cat list` | List categories with document counts |
66
+ | `artyfax tag list` | List tags with counts |
67
+ | `artyfax version list <slug>` | Version history |
68
+ | `artyfax version restore <slug>` | Restore a previous version |
67
69
 
68
70
  ### Annotations
69
71
 
70
72
  | Command | Description |
71
73
  |---------|-------------|
72
- | `arty note list <slug>` | List annotations on a document |
73
- | `arty note add <slug>` | Add a note (`--text` or stdin) |
74
- | `arty note search <query>` | Search across annotations |
74
+ | `artyfax annotation list <slug>` | List a document's annotations (`--include-recipients`, `--since`) |
75
+ | `artyfax annotation search <query>` | Search across annotations |
76
+
77
+ ### Snippets
78
+
79
+ | Command | Description |
80
+ |---------|-------------|
81
+ | `artyfax snippets` | List snippets (`--type`, `--tag`, `--starred`, `--limit`) |
82
+ | `artyfax snippets search <query>` | Search snippets (`--type`, `--limit`) |
83
+ | `artyfax snippets show <id>` | Show a snippet |
84
+ | `artyfax snippets new` | Create a snippet (`--text`/`--file`/`--image`, `--type`, `--tags`, …) |
85
+ | `artyfax snippets delete <id>` | Delete a snippet |
86
+ | `artyfax snippets star <id>` | Star a snippet |
87
+ | `artyfax snippets unstar <id>` | Unstar a snippet |
88
+
89
+ ### Projects and work
90
+
91
+ | Command | Description |
92
+ |---------|-------------|
93
+ | `artyfax init [prefix]` | Create or refresh `ARTYFAX.md` for a project board |
94
+ | `artyfax project list` | List projects |
95
+ | `artyfax project create "Name" --prefix XX` | Create a project (`--workspaces "A,B"` to scope, `--description`) |
96
+ | `artyfax work` | Show the board grouped by status |
97
+ | `artyfax work list` | List work items (`--project`, `--status`, `--type`, `--agent`) |
98
+ | `artyfax work next` | Pick the next item from Up Next (`--agent`) |
99
+ | `artyfax work start <id>` | Move an item to In Progress |
100
+ | `artyfax work done <id>` | Move an item to Done |
101
+ | `artyfax work status <id> <status>` | Set an item's status |
102
+ | `artyfax work create "Title" --project XX` | Create a work item (`--status`, `--type`, `--agent`) |
103
+ | `artyfax tasks <id>` | List a work item's tasks |
104
+ | `artyfax task <id> "text" <active\|done\|pending>` | Set a task's state |
105
+ | `artyfax workspace list` | List workspaces |
106
+
107
+ Work IDs (e.g. `AX-2`) are accepted anywhere a slug or UUID is.
75
108
 
76
109
  ### Tools
77
110
 
78
111
  | Command | Description |
79
112
  |---------|-------------|
80
- | `arty doctor` | Verify CLI setup |
81
- | `arty skill install` | Install Artyfax skills for Claude Code |
113
+ | `artyfax doctor` | Verify CLI setup |
114
+ | `artyfax skill install` | Install Artyfax skills for Claude Code |
82
115
 
83
116
  ## Global flags
84
117
 
@@ -94,8 +127,8 @@ arty doctor
94
127
  Every command supports `--help` for detailed usage and examples:
95
128
 
96
129
  ```bash
97
- arty save --help
98
- arty share --help
130
+ artyfax save --help
131
+ artyfax share --help
99
132
  ```
100
133
 
101
134
  ## Slug resolution
@@ -103,9 +136,9 @@ arty share --help
103
136
  Commands accept documents by full slug, bare name, or UUID:
104
137
 
105
138
  ```bash
106
- arty read inbox/my-doc # full slug
107
- arty read my-doc # bare name (resolves automatically)
108
- arty get 12345678-... # UUID
139
+ artyfax read inbox/my-doc # full slug
140
+ artyfax read my-doc # bare name (resolves automatically)
141
+ artyfax get 12345678-... # UUID
109
142
  ```
110
143
 
111
144
  ## E2E Encryption
@@ -114,13 +147,13 @@ Artyfax supports client-side encryption. The CLI handles encryption and decrypti
114
147
 
115
148
  ```bash
116
149
  # Save an encrypted document
117
- arty save secret.md --secure
150
+ artyfax save secret.md --secure
118
151
 
119
152
  # Read decrypts automatically (prompts for passphrase)
120
- arty read inbox/secret
153
+ artyfax read inbox/secret
121
154
 
122
155
  # Update auto-encrypts if the target is secure
123
- arty update inbox/secret updated.md
156
+ artyfax update inbox/secret updated.md
124
157
 
125
158
  # Set passphrase via env var to skip the prompt
126
159
  export ARTYFAX_SECURE_PASSPHRASE="your-passphrase"