artidrop 0.1.1 → 0.1.2
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 +74 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# artidrop
|
|
2
|
+
|
|
3
|
+
CLI to publish and share HTML/Markdown artifacts with a single command.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g artidrop
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick start
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Sign in (opens browser)
|
|
15
|
+
artidrop login
|
|
16
|
+
|
|
17
|
+
# Publish a file
|
|
18
|
+
artidrop publish ./report.html
|
|
19
|
+
|
|
20
|
+
# Publish markdown
|
|
21
|
+
artidrop publish ./notes.md --title "Meeting Notes"
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Agent / CI usage
|
|
25
|
+
|
|
26
|
+
For non-interactive environments, set an API key instead of using `artidrop login`:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
export ARTIDROP_API_KEY="sk-your-api-key"
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Pipe generated content from an AI agent:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
echo "<h1>Hello</h1>" | artidrop publish - --format html --title "Generated Report" --json
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Commands
|
|
39
|
+
|
|
40
|
+
| Command | Description |
|
|
41
|
+
|---------|-------------|
|
|
42
|
+
| `artidrop publish <path>` | Publish a file or stdin (`-`) |
|
|
43
|
+
| `artidrop list` | List your artifacts |
|
|
44
|
+
| `artidrop get <id>` | Show artifact details |
|
|
45
|
+
| `artidrop delete <id>` | Delete an artifact |
|
|
46
|
+
| `artidrop versions <id>` | Show version history |
|
|
47
|
+
| `artidrop login` | Sign in to artidrop |
|
|
48
|
+
| `artidrop logout` | Sign out |
|
|
49
|
+
| `artidrop whoami` | Show current user |
|
|
50
|
+
|
|
51
|
+
## Publish options
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
-t, --title <title> Artifact title (default: filename)
|
|
55
|
+
-f, --format <format> html or markdown (auto-detected from extension)
|
|
56
|
+
-v, --visibility <vis> public or unlisted (default: public)
|
|
57
|
+
-u, --update <id> Update existing artifact (new version)
|
|
58
|
+
-o, --open Open URL in browser after publishing
|
|
59
|
+
-c, --copy Copy URL to clipboard
|
|
60
|
+
--json Output full JSON response
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Configuration
|
|
64
|
+
|
|
65
|
+
Credentials are stored in `~/.config/artidrop/config.json` after `artidrop login`.
|
|
66
|
+
|
|
67
|
+
Environment variables take precedence over the config file:
|
|
68
|
+
|
|
69
|
+
- `ARTIDROP_API_KEY` — API key for authentication
|
|
70
|
+
- `ARTIDROP_API_URL` — Custom API endpoint (default: `https://api.artidrop.app`)
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT
|