Plan CLI
CLI tool for HTML Plan Service - Create, manage, and share HTML plans.
Features
- Create, update, delete plans
- Publish/unpublish plans (public URL)
- Pin plans via the web dashboard
Installation
# One-line install
curl -sSL https://raw.githubusercontent.com/Jemo69/html-planner-server/main/cli/install.sh | bash
Or manually:
cd cli
uv sync
Usage
Configuration
# Show current config
plan config show
# Set API URL
plan config set --api-url https://html-planner-server.fly.dev
# Get current API URL
plan config get
Authentication
# Register a new account
plan auth init --email your@email.com
# Login to existing account
plan auth login --email your@email.com
Plans
# Create a plan
plan plans create --project <project-id> --title "My Plan" --html plan.html
# List all plans
plan plans list
# List plans for a project
plan plans list --project <project-id>
# Get plan details
plan plans get <plan-id>
# Update a plan
plan plans update <plan-id> --html updated.html
# Delete a plan
plan plans delete <plan-id>
# Publish a plan (make public)
plan plans publish <plan-id>
# Unpublish a plan (make private)
plan plans unpublish <plan-id>
# Archive a plan
plan plans archive <plan-id>
# Restore an archived plan
plan plans unarchive <plan-id>
Configuration
The CLI stores configuration in ~/.plan-cli/config.json:
{
"api_url": "http://localhost:8000",
"api_key": "your-api-key"
}
Frontmatter Support
HTML files can include YAML frontmatter:
---
title: My Plan Title
description: Brief description
tags: [architecture, api-design]
visibility: public
---
<!DOCTYPE html>
<html>
...
</html>
The CLI will extract metadata from frontmatter and use it when creating plans.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
plan_cli-0.2.2.tar.gz
(17.3 kB
view details)
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
plan_cli-0.2.2-py3-none-any.whl
(12.6 kB
view details)
File details
Details for the file plan_cli-0.2.2.tar.gz.
File metadata
- Download URL: plan_cli-0.2.2.tar.gz
- Upload date:
- Size: 17.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25d7f46a9d7ff7ff3831ed324348bf91689485eeb955a8d111c4f40665ed847b
|
|
| MD5 |
c46d9c13d147bdc205622f2fd4214192
|
|
| BLAKE2b-256 |
b3cfc8da5a2a4333c611b08cea86b35f0a3fbbf96323c0e5d21642098cb2df12
|
File details
Details for the file plan_cli-0.2.2-py3-none-any.whl.
File metadata
- Download URL: plan_cli-0.2.2-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a2c2e441251096cc77b5df89d85f81f60ab255ef4adb451dadcd4d90e5431ec
|
|
| MD5 |
8c9f04a55c9725573c12b20107c1128d
|
|
| BLAKE2b-256 |
d15d44d673ecd0afc029425531d37e020642c3a09893a17e3803d2a26703513c
|
