41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# PWCLI
|
|
|
|
A CLI for Photowall, a platform for doing any type of commands or automation
|
|
needed for the photowall organisation.
|
|
|
|
# Installation
|
|
|
|
1. Clone the repo to a local folder.
|
|
2. Install dependencies with `yarn install`
|
|
2. Build the project with `yarn build`
|
|
3. Connect a runnable command with `yarn link`
|
|
5. Open a new terminal window and run `pwcli setup settings` and follow instructions.
|
|
|
|
# Usage
|
|
|
|
When running `pwcli` command in the terminal is will open a interactive view but all commands are accessable through shortcuts. So if you want to run status on development testservers its possible to run `pwcli d ts s` for d = development, ts = test servers, s = status. Shortcuts are listed in the interactive view.
|
|
|
|
## Interactive Mode
|
|
|
|
Run commands interactively with prompts and menus:
|
|
|
|
```bash
|
|
pwcli # Open interactive menu
|
|
pwcli d ts u # Update testserver with interactive prompts
|
|
pwcli d ts s # View testserver status in table format
|
|
```
|
|
|
|
## Non-Interactive Mode
|
|
|
|
Many commands support non-interactive mode with parameters and JSON output, perfect for CI/CD and automation:
|
|
|
|
```bash
|
|
# View testserver status as JSON
|
|
pwcli d ts s --json
|
|
|
|
# Update testserver without interactive prompts
|
|
pwcli d ts u --branch feature/123 --stack test-01 --skip-confirm --json
|
|
```
|
|
|
|
For detailed documentation including all flags, parameters, and JSON output formats, see [docs/help.md](docs/help.md).
|