Skip to content

Add --json output to read commands #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akshithg wants to merge 1 commit into
base: main
Choose a base branch
from
+512 −121
Open

Add --json output to read commands #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,28 @@ Commands:

Use `dropkit <command> --help` for detailed help on any command.

### Machine-readable output

Read commands render formatted tables by default. For scripting and agents,
pass `--json` to emit untruncated structured data instead. Supported on
`list`, `info`, `list-ssh-keys`, and `version`:

```bash
dropkit list --json | jq -r '.droplets[].name'
dropkit info my-droplet --json | jq -r '.ip'
dropkit list-ssh-keys --json | jq -r '.ssh_keys[].fingerprint'
```

- **`list --json`** — each droplet's `id`, `name`, `status`, `ip`,
`tailscale_ip`, `region`, `size`, `cost_monthly`, `in_ssh_config`,
`ssh_hostname`, and `tags`, plus a `hibernated` list and `total_monthly_cost`.
- **`info --json`** — the `list` fields plus `created_at`, `vcpus`,
`memory_mb`, `disk_gb`, `transfer_tb`, `image`, `features`, and full
`networks` (including IPv6).
- **`list-ssh-keys --json`** — `username` and an `ssh_keys` list of
`name`/`id`/`fingerprint`.
- **`version --json`** — the dropkit `version` string.

## Configuration

Configuration files are stored in `~/.config/dropkit/`:
Expand Down
Loading