@clipdone/cli 0.1.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 +91 -0
- package/bin/clipdone.js +1424 -0
- package/package.json +26 -0
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# ClipDone CLI
|
|
2
|
+
|
|
3
|
+
Command line access to ClipDone projects, uploads, processing runs, revisions, status and exports. (ClipDone is an automatic video editing tool.)
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Install globally for normal use:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @clipdone/cli
|
|
11
|
+
clipdone auth login
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
For one-off use without a global install:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @clipdone/cli auth login
|
|
18
|
+
pnpm dlx @clipdone/cli projects
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The CLI requires Node.js 18 or newer.
|
|
22
|
+
|
|
23
|
+
## Login
|
|
24
|
+
|
|
25
|
+
Authorize the CLI in your browser:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
clipdone auth login
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
On remote machines or environments where the CLI cannot open a browser automatically:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
clipdone auth login --no-open
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Check or remove the current login:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
clipdone me
|
|
41
|
+
clipdone auth logout
|
|
42
|
+
clipdone auth revoke
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`logout` removes only the local token. `revoke` also revokes the current OAuth tokens with ClipDone.
|
|
46
|
+
|
|
47
|
+
## Common workflow
|
|
48
|
+
|
|
49
|
+
List and create projects:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
clipdone projects
|
|
53
|
+
clipdone projects create --name "Marketing video"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Upload files:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
clipdone projects <project_id> upload ./video.mp4 --type footage
|
|
60
|
+
clipdone projects <project_id> upload ./music.mp3 --type music
|
|
61
|
+
clipdone projects <project_id> upload ./script.txt --type script
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Start processing, inspect status, and download an output:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
clipdone projects <project_id> process
|
|
68
|
+
clipdone projects <project_id> status
|
|
69
|
+
clipdone projects <project_id> outputs
|
|
70
|
+
clipdone outputs <output_id> download --out ./clipdone-output.mp4
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Create a revision from feedback:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
clipdone projects <project_id> revise --feedback "Make the intro tighter."
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Run `clipdone --help` for the full command list.
|
|
80
|
+
|
|
81
|
+
## Automation
|
|
82
|
+
|
|
83
|
+
For non-interactive CI runs, set `CLIPDONE_TOKEN` instead of using browser login:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
CLIPDONE_TOKEN=cd_... clipdone projects
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
When `CLIPDONE_TOKEN` is set, it overrides stored browser login tokens for that command.
|
|
90
|
+
|
|
91
|
+
Installed CLI usage talks to production ClipDone at `https://app.clipdone.app`.
|