From 05e9ada55bb2216677a3a10252ab2e044c83498e Mon Sep 17 00:00:00 2001 From: balthazarbk Date: Wed, 20 May 2026 13:19:29 +0200 Subject: [PATCH] Lint --- docs/help.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/help.md b/docs/help.md index 5887e1d..d1498b2 100644 --- a/docs/help.md +++ b/docs/help.md @@ -63,6 +63,7 @@ pwcli [command] [subcommand] [action] ### Command Shortcuts Commands can be executed using their aliases. For example: + - `pwcli d ts s` โ†’ deployment testservers status - `pwcli a ps l` โ†’ aws parameterstore list - `pwcli wf g cb` โ†’ workflow git clean_old_branches @@ -72,24 +73,29 @@ Commands can be executed using their aliases. For example: ## Available Commands ### ๐Ÿค– **ai** (alias: `ai`) + AI-related commands #### Subcommands: + - **schema** (alias: `sc`) - Output detailed pwcli command schema for LLM usage - **promptcontextlibrary** (alias: `pcl`) - Copy context files to clipboard for AI prompts **Examples:** + - `pwcli ai sc` - `pwcli ai pcl` --- ### โ˜๏ธ **aws** (alias: `a`) + AWS operations and management #### Subcommands: ##### **ecs** (alias: `e`) - Working with ECS on AWS + - **sshtestserver** (alias: `sts`) - SSH into a test server in ECS **Example:** `pwcli a e sts` @@ -99,38 +105,45 @@ AWS operations and management **Example:** `pwcli a l` ##### **parameterstore** (alias: `ps`) - Working with parameter store on AWS + - **bulk-create** (alias: `bc`) - Bulk create parameters from JSON file - **create** (alias: `c`) - Create a new item in parameter store - **list** (alias: `l`) - List all parameters in parameter store - **update** (alias: `u`) - Update an existing item in parameter store **Examples:** + - `pwcli a ps l` - List parameters - `pwcli a ps c` - Create parameter - `pwcli a ps bc` - Bulk create from JSON file ##### **pipeline** (alias: `pl`) - Pipeline operations + - **status** (alias: `s`) - View pipeline status with live tracking **Example:** `pwcli a pl s` ##### **s3** (alias: `s3`) - Working with S3 on AWS + - **clear_prints** (alias: `cp`) - Clear prints-dev bucket on S3 - **print_on_station** (alias: `pos`) - Print on a real station (copies from dev to production) - **sync_images** (alias: `si`) - Sync images between S3 buckets **Examples:** + - `pwcli a s3 si` - Sync images - `pwcli a s3 cp` - Clear prints --- ### ๐Ÿš€ **deployment** (alias: `d`) + Deployment and test server management #### Subcommands: ##### **testservers** (alias: `ts`) - Deploy to testservers + - **create** (alias: `c`) - Create new testserver on AWS - **delete** (alias: `d`) - Choose a testserver to delete - **grab** (alias: `g`) - Auto-pick a free testserver and update it with your current branch @@ -152,6 +165,7 @@ Deployment and test server management - `--json` - Output result in JSON format with success flag and message **Examples:** + - `pwcli d ts s` - View testserver status (interactive) - `pwcli d ts s --json` - View testserver status as JSON - `pwcli d ts c` - Create new testserver @@ -166,9 +180,11 @@ Deployment and test server management --- ### ๐Ÿ“ง **mandrill** (alias: `m`) + Mandrill/Mailchimp email template operations #### Subcommands: + - **fix_template** (alias: `ft`) - Remove incorrect artifacts caused by Mailchimp export to Mandrill **Example:** `pwcli m ft` @@ -176,9 +192,11 @@ Mandrill/Mailchimp email template operations --- ### โš™๏ธ **setup** (alias: `s`) + Setup pwcli configuration #### Subcommands: + - **settings** (alias: `se`) - Setup settings for pwcli (GitHub token, repo paths, API keys, etc.) **Example:** `pwcli setup settings` or `pwcli s se` @@ -186,9 +204,11 @@ Setup pwcli configuration --- ### ๐Ÿงช **test** (alias: `t`) + Test commands #### Subcommands: + - **routes** (alias: `r`) - Test pre-configured routes for 200 status on configured localhost **Example:** `pwcli t r` @@ -196,6 +216,7 @@ Test commands --- ### ๐Ÿ”„ **update** (alias: `up`) + Update pwcli to the latest version from main branch and rebuild **Example:** `pwcli update` or `pwcli up` @@ -203,19 +224,23 @@ Update pwcli to the latest version from main branch and rebuild --- ### ๐Ÿ”ง **workflow** (alias: `wf`) + Workflow tools for development #### Subcommands: ##### **git** (alias: `g`) - Tools for git to make repo life easier + - **clean_local_branches** (alias: `clb`) - Clean local branches without origin connection - **clean_old_branches** (alias: `cb`) - Prune remote and clean local branches if gone **Examples:** + - `pwcli wf g cb` - Clean old branches - `pwcli wf g clb` - Clean local branches ##### **setupissue** (alias: `si`) - Setup everything for an issue + Creates a new branch from origin/master based on a GitHub issue **Example:** `pwcli wf si` @@ -225,6 +250,7 @@ Creates a new branch from origin/master based on a GitHub issue ## Configuration Run `pwcli setup settings` to configure: + - GitHub access token - Local photowall repository path - Mandrill API key @@ -256,6 +282,7 @@ pwcli d ts s --json ``` **JSON Output Format:** + ```json [ { @@ -281,6 +308,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json ``` **Success Response:** + ```json { "success": true, @@ -292,6 +320,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json ``` **Error Response:** + ```json { "success": false, @@ -302,6 +331,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json ### Automation Examples **In a CI/CD Pipeline:** + ```bash #!/bin/bash # Deploy to testserver and check result @@ -318,6 +348,7 @@ fi ``` **Check testserver availability:** + ```bash # Get all testservers and find an available one pwcli d ts s --json | jq '.[] | select(.status == "UPDATE_COMPLETE") | .name' @@ -326,4 +357,3 @@ pwcli d ts s --json | jq '.[] | select(.status == "UPDATE_COMPLETE") | .name' --- For more information, visit the repository or run commands interactively with `pwcli` -