Streaks

Running actions

• Use st actions list and st actions describe <action> to inspect available actions and required parameters.
• Use --task for habit/task-based actions.
• Use --input or --stdin to pass raw JSON input.
• Use --dry-run to 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 --agent or STREAKS_CLI_AGENT=1 for NDJSON envelopes and stable errors.
• Use --shortcuts-output public.json when you need JSON data from Shortcuts.
• Use --no-output when only exit codes matter.

Troubleshooting

• Use st doctor for readiness checks.
• Use st discover --markdown for a human-readable capability report.
• If an action fails, check stderr JSON in agent mode and consult exit codes.

References

• Use references/commands.md for the full command/flag list and env vars.
• Use references/agent.md for NDJSON conventions and integration patterns.
• Use references/schema.md for exit codes and envelope schemas.
• Use references/troubleshooting.md for common errors and fixes.