first
This commit is contained in:
@@ -0,0 +1,168 @@
|
||||
---
|
||||
name: fizzy-cli
|
||||
description: Manage Fizzy boards, cards, columns, and comments from the command line. Use when the user wants to create, list, update, or organize cards and boards on Fizzy.
|
||||
---
|
||||
|
||||
# Fizzy CLI
|
||||
|
||||
CLI reference for fizzy-cli — a command-line interface for the Fizzy API to manage boards, cards, columns, comments, and more.
|
||||
|
||||
Source: https://github.com/robzolkos/fizzy-cli
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration sources in order of precedence (highest first):
|
||||
|
||||
1. **Command-line flags** (`--token`, `--account`, `--api-url`)
|
||||
2. **Environment variables** (`FIZZY_TOKEN`, `FIZZY_ACCOUNT`, `FIZZY_API_URL`, `FIZZY_BOARD`)
|
||||
3. **Local project config** (`.fizzy.yaml` in current or parent directories)
|
||||
4. **Global config** (`~/.config/fizzy/config.yaml` or `~/.fizzy/config.yaml`)
|
||||
|
||||
Run `fizzy setup` for interactive configuration.
|
||||
|
||||
## Global Options
|
||||
|
||||
| Flag | Env Variable | Description |
|
||||
|------|-------------|-------------|
|
||||
| `--token` | `FIZZY_TOKEN` | API access token |
|
||||
| `--account` | `FIZZY_ACCOUNT` | Account identifier |
|
||||
| `--api-url` | `FIZZY_API_URL` | API base URL (default: `https://app.fizzy.do`) |
|
||||
| `--verbose` | — | Display request/response details |
|
||||
|
||||
---
|
||||
|
||||
## Commands
|
||||
|
||||
### Boards
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy board list` | List all boards |
|
||||
| `fizzy board show BOARD_ID` | Display board details |
|
||||
| `fizzy board create --name "Name"` | Create a new board |
|
||||
| `fizzy board update BOARD_ID --name "Name"` | Update a board |
|
||||
| `fizzy board delete BOARD_ID` | Delete a board |
|
||||
|
||||
### Cards
|
||||
|
||||
#### List cards
|
||||
|
||||
```bash
|
||||
fizzy card list [--board ID] [--column ID] [--tag ID] [--assignee ID]
|
||||
fizzy card list [--sort newest|oldest|latest] [--search "text"]
|
||||
fizzy card list [--created thisweek] [--closed thisweek] [--unassigned]
|
||||
```
|
||||
|
||||
#### CRUD
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy card show CARD_ID` | View card details |
|
||||
| `fizzy card create --board ID --title "Title"` | Create a card |
|
||||
| `fizzy card update CARD_ID --title "Title"` | Update a card |
|
||||
| `fizzy card delete CARD_ID` | Delete a card |
|
||||
|
||||
#### Card actions
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy card close CARD_ID` | Close a card |
|
||||
| `fizzy card reopen CARD_ID` | Reopen a card |
|
||||
| `fizzy card move CARD_ID --to BOARD_ID` | Move card to another board |
|
||||
| `fizzy card postpone CARD_ID` | Postpone a card |
|
||||
| `fizzy card column CARD_ID --column COLUMN_ID` | Assign card to a column |
|
||||
| `fizzy card assign CARD_ID --user USER_ID` | Assign card to a user |
|
||||
| `fizzy card tag CARD_ID --tag "tag"` | Tag a card |
|
||||
| `fizzy card pin CARD_ID` | Pin a card |
|
||||
| `fizzy card unpin CARD_ID` | Unpin a card |
|
||||
| `fizzy card golden CARD_ID` | Mark card as golden |
|
||||
| `fizzy card ungolden CARD_ID` | Remove golden status |
|
||||
| `fizzy card watch CARD_ID` | Watch a card |
|
||||
| `fizzy card unwatch CARD_ID` | Unwatch a card |
|
||||
|
||||
#### Card attachments
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy card attachments show CARD_ID` | List attachments |
|
||||
| `fizzy card attachments download CARD_ID` | Download all attachments |
|
||||
| `fizzy card attachments download CARD_ID ATT_ID` | Download specific attachment |
|
||||
|
||||
### Columns
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy column list --board ID` | List columns |
|
||||
| `fizzy column show COLUMN_ID --board ID` | View column |
|
||||
| `fizzy column create --board ID --name "Name"` | Create column |
|
||||
| `fizzy column update COLUMN_ID --board ID --name "Name"` | Update column |
|
||||
| `fizzy column delete COLUMN_ID --board ID` | Delete column |
|
||||
|
||||
### Comments
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy comment list --card CARD_ID` | List comments |
|
||||
| `fizzy comment show COMMENT_ID --card CARD_ID` | View comment |
|
||||
| `fizzy comment create --card CARD_ID --body "Text"` | Add comment |
|
||||
| `fizzy comment update COMMENT_ID --card CARD_ID --body "Text"` | Edit comment |
|
||||
| `fizzy comment delete COMMENT_ID --card CARD_ID` | Delete comment |
|
||||
|
||||
#### Comment attachments
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy comment attachments show --card CARD_ID` | List attachments |
|
||||
| `fizzy comment attachments download --card CARD_ID` | Download all |
|
||||
| `fizzy comment attachments download --card CARD_ID ATT_ID` | Download specific |
|
||||
|
||||
### Steps (To-Do Items)
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy step show STEP_ID --card CARD_ID` | View step |
|
||||
| `fizzy step create --card CARD_ID --content "Task"` | Create step |
|
||||
| `fizzy step update STEP_ID --card CARD_ID --completed` | Mark step complete |
|
||||
| `fizzy step delete STEP_ID --card CARD_ID` | Delete step |
|
||||
|
||||
### Reactions
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy reaction list --card CARD_ID` | List reactions |
|
||||
| `fizzy reaction create --card CARD_ID --content "👍"` | Add reaction |
|
||||
| `fizzy reaction delete REACTION_ID --card CARD_ID` | Remove reaction |
|
||||
|
||||
### Users & Tags
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy user list` | List users |
|
||||
| `fizzy user show USER_ID` | View user details |
|
||||
| `fizzy tag list` | List available tags |
|
||||
|
||||
### Pins, Search & Notifications
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fizzy pin list` | List pinned cards |
|
||||
| `fizzy search "term"` | Full-text card search |
|
||||
| `fizzy notification list` | List notifications |
|
||||
| `fizzy notification read ID` | Mark notification as read |
|
||||
| `fizzy notification unread ID` | Mark notification as unread |
|
||||
| `fizzy notification read-all` | Mark all notifications as read |
|
||||
|
||||
### File Uploads
|
||||
|
||||
```bash
|
||||
fizzy upload file /path/to/file.png
|
||||
# Returns: { "signed_id": "...", "attachable_sgid": "..." }
|
||||
```
|
||||
|
||||
Use `signed_id` for card headers; `attachable_sgid` for inline images in rich text.
|
||||
|
||||
---
|
||||
|
||||
## Source
|
||||
|
||||
- Repository: https://github.com/robzolkos/fizzy-cli
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
||||
{"id":"44cc6c97-2a5e-4c39-86a7-121e4ecf2bab"}
|
||||
Reference in New Issue
Block a user