Command-line interface for OpenDraft screenwriting platform
Project description
opendraft-cli
Command-line interface for OpenDraft — the open-source screenwriting platform.
Manage projects, scripts, versions, exports, collaboration, and formatting templates directly from your terminal or AI agent (Claude Code / OpenClaw).
Installation
pip install opendraft-cli
Requirements
- Python 3.10+
- OpenDraft backend running (locally or remote)
Quick Start
# Point at your OpenDraft backend (default: http://localhost:8000)
export OPENDRAFT_URL=http://localhost:8000
# List projects
opendraft --json projects list
# Create a project
opendraft --json projects create --name "My Screenplay"
# Create a script inside that project
opendraft --json scripts create <project-id> --title "Act One"
# Check in a version
opendraft --json versions checkin <project-id> --message "First draft"
# Export to Fountain
opendraft --json export fountain <script-id>
Note:
--jsonis a root-level flag and must come before the subcommand.opendraft --json projects list✓
opendraft projects list --json✗
Command Reference
| Group | Commands |
|---|---|
projects |
list create get update delete |
scripts |
list create get update duplicate delete |
versions |
list checkin diff restore |
export |
fountain pdf fdx |
collab |
invite sessions revoke revoke-all |
templates |
list create get update delete set-element |
Run opendraft --help or opendraft <group> --help for full options.
Output Format
All commands support --json for machine-readable output:
{"ok": true, "data": {...}}
{"ok": false, "error": "Not found", "code": 404}
Human-readable output (default) uses rich tables and colored text.
Configuration
| Env Var | Default | Description |
|---|---|---|
OPENDRAFT_URL |
http://localhost:8000 |
Backend base URL |
AI Agent Integration
See SKILL.md for Claude Code / OpenClaw integration instructions.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file opendraft_cli-0.1.0.tar.gz.
File metadata
- Download URL: opendraft_cli-0.1.0.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7e54be68b28014c854c360d47efb2fcf32f0feb9690a05de9e2ac3ea65a6346
|
|
| MD5 |
c3a7a8ddbc57f6418719f70cff26fb06
|
|
| BLAKE2b-256 |
b41bae9fb71cfb3f1ddeb15d831cdacf55c9593b1177d131fcbd6b297bf27416
|
File details
Details for the file opendraft_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: opendraft_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b1b458f45564bb872fecca47c6932c5ec80758463b0a6404f0e5c4f4a680e3b
|
|
| MD5 |
28b728ef164887e3fd55327b971622e6
|
|
| BLAKE2b-256 |
fa13ad01702d99a96894d612d77e7d51018a0d9e7bbe69b0fedcb2c17889d728
|