Lint
This commit is contained in:
+31
-1
@@ -63,6 +63,7 @@ pwcli [command] [subcommand] [action]
|
|||||||
### Command Shortcuts
|
### Command Shortcuts
|
||||||
|
|
||||||
Commands can be executed using their aliases. For example:
|
Commands can be executed using their aliases. For example:
|
||||||
|
|
||||||
- `pwcli d ts s` → deployment testservers status
|
- `pwcli d ts s` → deployment testservers status
|
||||||
- `pwcli a ps l` → aws parameterstore list
|
- `pwcli a ps l` → aws parameterstore list
|
||||||
- `pwcli wf g cb` → workflow git clean_old_branches
|
- `pwcli wf g cb` → workflow git clean_old_branches
|
||||||
@@ -72,24 +73,29 @@ Commands can be executed using their aliases. For example:
|
|||||||
## Available Commands
|
## Available Commands
|
||||||
|
|
||||||
### 🤖 **ai** (alias: `ai`)
|
### 🤖 **ai** (alias: `ai`)
|
||||||
|
|
||||||
AI-related commands
|
AI-related commands
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
- **schema** (alias: `sc`) - Output detailed pwcli command schema for LLM usage
|
- **schema** (alias: `sc`) - Output detailed pwcli command schema for LLM usage
|
||||||
- **promptcontextlibrary** (alias: `pcl`) - Copy context files to clipboard for AI prompts
|
- **promptcontextlibrary** (alias: `pcl`) - Copy context files to clipboard for AI prompts
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- `pwcli ai sc`
|
- `pwcli ai sc`
|
||||||
- `pwcli ai pcl`
|
- `pwcli ai pcl`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ☁️ **aws** (alias: `a`)
|
### ☁️ **aws** (alias: `a`)
|
||||||
|
|
||||||
AWS operations and management
|
AWS operations and management
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
##### **ecs** (alias: `e`) - Working with ECS on AWS
|
##### **ecs** (alias: `e`) - Working with ECS on AWS
|
||||||
|
|
||||||
- **sshtestserver** (alias: `sts`) - SSH into a test server in ECS
|
- **sshtestserver** (alias: `sts`) - SSH into a test server in ECS
|
||||||
|
|
||||||
**Example:** `pwcli a e sts`
|
**Example:** `pwcli a e sts`
|
||||||
@@ -99,38 +105,45 @@ AWS operations and management
|
|||||||
**Example:** `pwcli a l`
|
**Example:** `pwcli a l`
|
||||||
|
|
||||||
##### **parameterstore** (alias: `ps`) - Working with parameter store on AWS
|
##### **parameterstore** (alias: `ps`) - Working with parameter store on AWS
|
||||||
|
|
||||||
- **bulk-create** (alias: `bc`) - Bulk create parameters from JSON file
|
- **bulk-create** (alias: `bc`) - Bulk create parameters from JSON file
|
||||||
- **create** (alias: `c`) - Create a new item in parameter store
|
- **create** (alias: `c`) - Create a new item in parameter store
|
||||||
- **list** (alias: `l`) - List all parameters in parameter store
|
- **list** (alias: `l`) - List all parameters in parameter store
|
||||||
- **update** (alias: `u`) - Update an existing item in parameter store
|
- **update** (alias: `u`) - Update an existing item in parameter store
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- `pwcli a ps l` - List parameters
|
- `pwcli a ps l` - List parameters
|
||||||
- `pwcli a ps c` - Create parameter
|
- `pwcli a ps c` - Create parameter
|
||||||
- `pwcli a ps bc` - Bulk create from JSON file
|
- `pwcli a ps bc` - Bulk create from JSON file
|
||||||
|
|
||||||
##### **pipeline** (alias: `pl`) - Pipeline operations
|
##### **pipeline** (alias: `pl`) - Pipeline operations
|
||||||
|
|
||||||
- **status** (alias: `s`) - View pipeline status with live tracking
|
- **status** (alias: `s`) - View pipeline status with live tracking
|
||||||
|
|
||||||
**Example:** `pwcli a pl s`
|
**Example:** `pwcli a pl s`
|
||||||
|
|
||||||
##### **s3** (alias: `s3`) - Working with S3 on AWS
|
##### **s3** (alias: `s3`) - Working with S3 on AWS
|
||||||
|
|
||||||
- **clear_prints** (alias: `cp`) - Clear prints-dev bucket on S3
|
- **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)
|
- **print_on_station** (alias: `pos`) - Print on a real station (copies from dev to production)
|
||||||
- **sync_images** (alias: `si`) - Sync images between S3 buckets
|
- **sync_images** (alias: `si`) - Sync images between S3 buckets
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- `pwcli a s3 si` - Sync images
|
- `pwcli a s3 si` - Sync images
|
||||||
- `pwcli a s3 cp` - Clear prints
|
- `pwcli a s3 cp` - Clear prints
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 🚀 **deployment** (alias: `d`)
|
### 🚀 **deployment** (alias: `d`)
|
||||||
|
|
||||||
Deployment and test server management
|
Deployment and test server management
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
##### **testservers** (alias: `ts`) - Deploy to testservers
|
##### **testservers** (alias: `ts`) - Deploy to testservers
|
||||||
|
|
||||||
- **create** (alias: `c`) - Create new testserver on AWS
|
- **create** (alias: `c`) - Create new testserver on AWS
|
||||||
- **delete** (alias: `d`) - Choose a testserver to delete
|
- **delete** (alias: `d`) - Choose a testserver to delete
|
||||||
- **grab** (alias: `g`) - Auto-pick a free testserver and update it with your current branch
|
- **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
|
- `--json` - Output result in JSON format with success flag and message
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- `pwcli d ts s` - View testserver status (interactive)
|
- `pwcli d ts s` - View testserver status (interactive)
|
||||||
- `pwcli d ts s --json` - View testserver status as JSON
|
- `pwcli d ts s --json` - View testserver status as JSON
|
||||||
- `pwcli d ts c` - Create new testserver
|
- `pwcli d ts c` - Create new testserver
|
||||||
@@ -166,9 +180,11 @@ Deployment and test server management
|
|||||||
---
|
---
|
||||||
|
|
||||||
### 📧 **mandrill** (alias: `m`)
|
### 📧 **mandrill** (alias: `m`)
|
||||||
|
|
||||||
Mandrill/Mailchimp email template operations
|
Mandrill/Mailchimp email template operations
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
- **fix_template** (alias: `ft`) - Remove incorrect artifacts caused by Mailchimp export to Mandrill
|
- **fix_template** (alias: `ft`) - Remove incorrect artifacts caused by Mailchimp export to Mandrill
|
||||||
|
|
||||||
**Example:** `pwcli m ft`
|
**Example:** `pwcli m ft`
|
||||||
@@ -176,9 +192,11 @@ Mandrill/Mailchimp email template operations
|
|||||||
---
|
---
|
||||||
|
|
||||||
### ⚙️ **setup** (alias: `s`)
|
### ⚙️ **setup** (alias: `s`)
|
||||||
|
|
||||||
Setup pwcli configuration
|
Setup pwcli configuration
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
- **settings** (alias: `se`) - Setup settings for pwcli (GitHub token, repo paths, API keys, etc.)
|
- **settings** (alias: `se`) - Setup settings for pwcli (GitHub token, repo paths, API keys, etc.)
|
||||||
|
|
||||||
**Example:** `pwcli setup settings` or `pwcli s se`
|
**Example:** `pwcli setup settings` or `pwcli s se`
|
||||||
@@ -186,9 +204,11 @@ Setup pwcli configuration
|
|||||||
---
|
---
|
||||||
|
|
||||||
### 🧪 **test** (alias: `t`)
|
### 🧪 **test** (alias: `t`)
|
||||||
|
|
||||||
Test commands
|
Test commands
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
- **routes** (alias: `r`) - Test pre-configured routes for 200 status on configured localhost
|
- **routes** (alias: `r`) - Test pre-configured routes for 200 status on configured localhost
|
||||||
|
|
||||||
**Example:** `pwcli t r`
|
**Example:** `pwcli t r`
|
||||||
@@ -196,6 +216,7 @@ Test commands
|
|||||||
---
|
---
|
||||||
|
|
||||||
### 🔄 **update** (alias: `up`)
|
### 🔄 **update** (alias: `up`)
|
||||||
|
|
||||||
Update pwcli to the latest version from main branch and rebuild
|
Update pwcli to the latest version from main branch and rebuild
|
||||||
|
|
||||||
**Example:** `pwcli update` or `pwcli up`
|
**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** (alias: `wf`)
|
||||||
|
|
||||||
Workflow tools for development
|
Workflow tools for development
|
||||||
|
|
||||||
#### Subcommands:
|
#### Subcommands:
|
||||||
|
|
||||||
##### **git** (alias: `g`) - Tools for git to make repo life easier
|
##### **git** (alias: `g`) - Tools for git to make repo life easier
|
||||||
|
|
||||||
- **clean_local_branches** (alias: `clb`) - Clean local branches without origin connection
|
- **clean_local_branches** (alias: `clb`) - Clean local branches without origin connection
|
||||||
- **clean_old_branches** (alias: `cb`) - Prune remote and clean local branches if gone
|
- **clean_old_branches** (alias: `cb`) - Prune remote and clean local branches if gone
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- `pwcli wf g cb` - Clean old branches
|
- `pwcli wf g cb` - Clean old branches
|
||||||
- `pwcli wf g clb` - Clean local branches
|
- `pwcli wf g clb` - Clean local branches
|
||||||
|
|
||||||
##### **setupissue** (alias: `si`) - Setup everything for an issue
|
##### **setupissue** (alias: `si`) - Setup everything for an issue
|
||||||
|
|
||||||
Creates a new branch from origin/master based on a GitHub issue
|
Creates a new branch from origin/master based on a GitHub issue
|
||||||
|
|
||||||
**Example:** `pwcli wf si`
|
**Example:** `pwcli wf si`
|
||||||
@@ -225,6 +250,7 @@ Creates a new branch from origin/master based on a GitHub issue
|
|||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Run `pwcli setup settings` to configure:
|
Run `pwcli setup settings` to configure:
|
||||||
|
|
||||||
- GitHub access token
|
- GitHub access token
|
||||||
- Local photowall repository path
|
- Local photowall repository path
|
||||||
- Mandrill API key
|
- Mandrill API key
|
||||||
@@ -256,6 +282,7 @@ pwcli d ts s --json
|
|||||||
```
|
```
|
||||||
|
|
||||||
**JSON Output Format:**
|
**JSON Output Format:**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
@@ -281,6 +308,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Success Response:**
|
**Success Response:**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"success": true,
|
"success": true,
|
||||||
@@ -292,6 +320,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Error Response:**
|
**Error Response:**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"success": false,
|
"success": false,
|
||||||
@@ -302,6 +331,7 @@ pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json
|
|||||||
### Automation Examples
|
### Automation Examples
|
||||||
|
|
||||||
**In a CI/CD Pipeline:**
|
**In a CI/CD Pipeline:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Deploy to testserver and check result
|
# Deploy to testserver and check result
|
||||||
@@ -318,6 +348,7 @@ fi
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Check testserver availability:**
|
**Check testserver availability:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Get all testservers and find an available one
|
# Get all testservers and find an available one
|
||||||
pwcli d ts s --json | jq '.[] | select(.status == "UPDATE_COMPLETE") | .name'
|
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`
|
For more information, visit the repository or run commands interactively with `pwcli`
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user