Skip to main content

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: --json is 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

Metadata

Release files for opendraft-cli 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opendraft-cli 0.1.0
File Size Uploaded
opendraft_cli-0.1.0.tar.gz 11.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for opendraft-cli 0.1.0
File Interpreter ABI Platform
opendraft_cli-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.9 kB

Release files / opendraft_cli-0.1.0.tar.gz

Download URL opendraft_cli-0.1.0.tar.gz
Size 11.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f7e54be68b28014c854c360d47efb2fcf32f0feb9690a05de9e2ac3ea65a6346
BLAKE2b-256 checksum
How to use checksums
b41bae9fb71cfb3f1ddeb15d831cdacf55c9593b1177d131fcbd6b297bf27416
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.10

Release files / opendraft_cli-0.1.0-py3-none-any.whl

Download URL opendraft_cli-0.1.0-py3-none-any.whl
Size 11.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2b1b458f45564bb872fecca47c6932c5ec80758463b0a6404f0e5c4f4a680e3b
BLAKE2b-256 checksum
How to use checksums
fa13ad01702d99a96894d612d77e7d51018a0d9e7bbe69b0fedcb2c17889d728
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.10

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page