Refactor release workflow and update documentation for Homebrew installation
This commit is contained in:
@@ -1,5 +1,8 @@
|
||||
# Planka CLI
|
||||
|
||||
[](https://github.com/voydz/planka-cli/releases)
|
||||
[](https://github.com/voydz/homebrew-tap)
|
||||
|
||||
Cut through the UI and drive your Planka boards from the terminal. This CLI lets you
|
||||
scan work, create cards, and stay on top of notifications with fast, scriptable commands.
|
||||
|
||||
@@ -11,17 +14,20 @@ scan work, create cards, and stay on top of notifications with fast, scriptable
|
||||
|
||||
## Quick start
|
||||
|
||||
Requirements: Python 3.10+ and a Planka account.
|
||||
Requirements: A Planka account. For Homebrew installs, macOS + Homebrew. For source/pipx
|
||||
installs, Python 3.10+.
|
||||
|
||||
### Install (local or from Git)
|
||||
### Install (Homebrew, recommended)
|
||||
|
||||
```bash
|
||||
# Local dev
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -e .
|
||||
brew tap voydz/homebrew-tap
|
||||
brew install planka-cli
|
||||
```
|
||||
|
||||
# Or install from GitHub
|
||||
### Install (other options)
|
||||
|
||||
```bash
|
||||
# Install from GitHub
|
||||
pipx install git+https://github.com/voydz/planka-cli
|
||||
```
|
||||
|
||||
@@ -54,6 +60,7 @@ export PLANKA_PASSWORD=secret
|
||||
## Common commands
|
||||
|
||||
```bash
|
||||
planka-cli
|
||||
planka-cli status
|
||||
planka-cli login --url https://planka.example --username alice --password secret
|
||||
planka-cli logout
|
||||
@@ -71,14 +78,26 @@ planka-cli notifications all
|
||||
planka-cli notifications unread
|
||||
```
|
||||
|
||||
## Project layout
|
||||
## Maintainers
|
||||
|
||||
Developer docs live in `docs/`. Release automation notes are in `docs/tap-automation.md`.
|
||||
|
||||
### Local dev
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Project layout
|
||||
|
||||
- `scripts/planka_cli.py` CLI entrypoint
|
||||
- `docs/` supporting documentation
|
||||
- `pyproject.toml` packaging metadata
|
||||
- `Makefile` helpers for setup and binary builds
|
||||
|
||||
## Development
|
||||
### Development
|
||||
|
||||
```bash
|
||||
make setup
|
||||
@@ -86,7 +105,7 @@ make run
|
||||
make build
|
||||
```
|
||||
|
||||
## TBD
|
||||
### TBD
|
||||
|
||||
- Release workflow only builds the macOS binary.
|
||||
- Release workflow assumes a GitHub release is already published.
|
||||
|
||||
Reference in New Issue
Block a user