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>
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.
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.0.tar.gz
(17.2 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.0-py3-none-any.whl
(12.5 kB
view details)
File details
Details for the file plan_cli-0.2.0.tar.gz.
File metadata
- Download URL: plan_cli-0.2.0.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
990677513b69e3a12d901ef6756ae66ed980cb34bf5705281cbaa58b2cff1a4e
|
|
| MD5 |
deda4d3e25934b80aa52c297b56782fd
|
|
| BLAKE2b-256 |
9a1e0744e069c6280a727607a6deafecbb7bce9d8e595a2a33a62a1ff4071b06
|
File details
Details for the file plan_cli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: plan_cli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 12.5 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 |
0f317e02bb4c818ed66e1788a9139d2364a8ffc29ce9fa22846303f55dc36ed1
|
|
| MD5 |
a5d27cb6b934f595799ac9531da1cbde
|
|
| BLAKE2b-256 |
40133d46b66dbf85e9632ae1bbde4b7ace013ef95c248d8e01c057e442dcbd57
|