Skip to the page

Commands and flags

Each Buzzmark tool is a command: `buzzmark schedule-post` runs the schedule_post tool, and `buzzmark tools` lists them all.

A plain input is a flag, and a nested one goes in as JSON with --input, from the command line or stdin.

The commands come from Buzzmark each time the CLI runs, so a new tool works without updating the CLI.

See every command

Terminal

npx buzzmark list-social-sets
npx buzzmark write-posts --help
npx buzzmark upload launch.png --post-id 42

buzzmark tools answers every command as JSON: the command, the tool it runs and its title. buzzmark help <tool> shows what one tool does and every flag it takes. Tools describes each tool in full.

A command is the tool's name with dashes, and the tool's own name works too: buzzmark schedule-post and buzzmark schedule_post run the same tool.

Give a tool its inputs

  • A plain input is a flag: --post-id 42.
  • A yes or no is the flag on its own or with no- in front: --save-as-drafts, --no-save-as-drafts.
  • A list takes commas or the flag again: --account-ids 3,4 or --account-ids 3 --account-ids 4.
  • An input with a fixed set of values takes one of them, and the tool's help lists them.

A nested input, like the posts of a thread, goes in as JSON with --input '{...}', or --input - to read the JSON from stdin. Flags win over --input, so a script can send a saved JSON file and change one value with a flag.

Terminal

buzzmark schedule-post --post-id 42 --when best_time
cat week.json | buzzmark schedule-posts --input -

What stays in Buzzmark

No command posts right away. The most a command can do is put a Buzz on your calendar at least 5 minutes out or in the next free slot, where you can still change it or take it back. A command can't delete a scheduled or published Buzz, or change your plan, billing or sign-in.

A command works as the key's maker, with their role and brands. If that role needs approval before a Buzz goes out, a Buzz the CLI schedules goes for approval too. See Approval and Activity.

Where to next