artyfax 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Artyfax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+# artyfax
+
+CLI for [Artyfax](https://artyfax.io) - your personal document library. Save, theme, search, and share your documents from the terminal.
+
+## Installation
+
+```bash
+npm install -g artyfax
+```
+
+Requires Node.js 20 or later.
+
+## Quick start
+
+```bash
+# Set your API key
+export ARTYFAX_API_KEY="your-api-key"
+
+# Save a document
+arty save notes.md --category inbox
+
+# List your documents
+arty list
+
+# Search your library
+arty search "deployment guide"
+
+# Check your setup
+arty doctor
+```
+
+## Commands
+
+### Documents
+
+| Command | Description |
+|---------|-------------|
+| `arty save <file>` | Save a document (markdown or HTML) |
+| `arty save --url <url>` | Save from a URL (server-side extraction) |
+| `arty read <slug>` | Read document content (handles E2EE decryption) |
+| `arty list` | List documents |
+| `arty get <slug>` | Document metadata as JSON |
+| `arty search <query>` | Full-text search |
+| `arty update <slug> <file>` | Push updated content (auto-encrypts secure docs) |
+| `arty metadata <slug>` | Update document metadata |
+| `arty delete <slug>` | Delete a document |
+| `arty open <slug>` | Open document in browser |
+| `arty secure <slug>` | Encrypt a document |
+| `arty unsecure <slug>` | Remove encryption |
+
+### Shares
+
+| Command | Description |
+|---------|-------------|
+| `arty share create <slug>` | Create a share link |
+| `arty share list [slug]` | List shares |
+| `arty share revoke <hash>` | Revoke a share link |
+
+### Sub-resources
+
+| Command | Description |
+|---------|-------------|
+| `arty cat list` | List categories with document counts |
+| `arty tag list` | List tags with counts |
+| `arty version list <slug>` | Version history |
+| `arty version restore <slug>` | Restore a previous version |
+
+### Annotations
+
+| Command | Description |
+|---------|-------------|
+| `arty note list <slug>` | List annotations on a document |
+| `arty note add <slug>` | Add a note (`--text` or stdin) |
+| `arty note search <query>` | Search across annotations |
+
+### Tools
+
+| Command | Description |
+|---------|-------------|
+| `arty doctor` | Verify CLI setup |
+| `arty skill install` | Install Artyfax skills for Claude Code |
+
+## Global flags
+
+| Flag | Description |
+|------|-------------|
+| `--json` | Machine-readable JSON output |
+| `--yes`, `-y` | Skip interactive confirmations |
+| `--api-key <key>` | API key (prefer env var) |
+| `--endpoint <url>` | API endpoint |
+| `--help`, `-h` | Show help |
+| `--version`, `-v` | Show version |
+
+Every command supports `--help` for detailed usage and examples:
+
+```bash
+arty save --help
+arty share --help
+```
+
+## Slug resolution
+
+Commands accept documents by full slug, bare name, or UUID:
+
+```bash
+arty read inbox/my-doc          # full slug
+arty read my-doc                # bare name (resolves automatically)
+arty get 12345678-...           # UUID
+```
+
+## E2E Encryption
+
+Artyfax supports client-side encryption. The CLI handles encryption and decryption transparently.
+
+```bash
+# Save an encrypted document
+arty save secret.md --secure
+
+# Read decrypts automatically (prompts for passphrase)
+arty read inbox/secret
+
+# Update auto-encrypts if the target is secure
+arty update inbox/secret updated.md
+
+# Set passphrase via env var to skip the prompt
+export ARTYFAX_SECURE_PASSPHRASE="your-passphrase"
+```
+
+## Environment variables
+
+| Variable | Description |
+|----------|-------------|
+| `ARTYFAX_API_KEY` | API key for authentication (required) |
+| `ARTYFAX_ENDPOINT` | API endpoint URL (default: `https://artyfax.io`) |
+| `ARTYFAX_SECURE_PASSPHRASE` | E2EE passphrase (avoids interactive prompt) |
+
+## License
+
+MIT