name: streaks
description: "Use when managing Streaks app habits via the Streaks CLI (st): discover actions, link Shortcuts, run habit/task actions, configure output (agent NDJSON, JSON UTI), troubleshoot install/doctor/discover, or interpret exit codes and JSON envelopes for automation."
Streaks CLI
Overview
Use this skill to manage Streaks app habits via the st CLI with Shortcuts-based actions and the streaks:// URL scheme. The st CLI must be installed to use this skill.
Install the CLI with Homebrew (brew tap vburojevic/tap then brew install streaks-cli) or from source (make build).
Quick start
- Run
st discoverandst doctorto validate app + Shortcuts readiness. - Run
st opento confirm Streaks launches. - Run
st helporst help <command>to resolve usage questions.
Core workflow
- Discover capabilities:
st discover(use--agentfor NDJSON). - Verify setup:
st doctor. - Ensure shortcuts exist:
- If missing, create them in Shortcuts or import wrapper
.shortcutfiles withst install --import.
- If missing, create them in Shortcuts or import wrapper
- Map custom shortcut names with
st link <action-id> --shortcut "Name". - Run actions:
st <action> [--task "Habit"]. - When automating, enable agent mode and parse the last NDJSON line.
Running actions
- Use
st actions listandst actions describe <action>to inspect available actions and required parameters. - Use
--taskfor habit/task-based actions. - Use
--inputor--stdinto pass raw JSON input. - Use
--dry-runto verify shortcut name + payload before execution. - Use
--trace <file>to append JSONL trace records.
Output and automation
- Default output is human-oriented for meta commands and raw shortcut output for actions.
- Use
--agentorSTREAKS_CLI_AGENT=1for NDJSON envelopes and stable errors. - Use
--shortcuts-output public.jsonwhen you need JSON data from Shortcuts. - Use
--no-outputwhen only exit codes matter.
Troubleshooting
- Use
st doctorfor readiness checks. - Use
st discover --markdownfor a human-readable capability report. - If an action fails, check stderr JSON in agent mode and consult exit codes.
References
- Use
references/commands.mdfor the full command/flag list and env vars. - Use
references/agent.mdfor NDJSON conventions and integration patterns. - Use
references/schema.mdfor exit codes and envelope schemas. - Use
references/troubleshooting.mdfor common errors and fixes.