CLI reference

Documentation

postx v1.0.4 is a terminal workflow for drafting, scheduling, and publishing social posts. Channel coverage expands over time—use postx channels to see what is available in your build.

Install

The recommended install path for most users is npm.

Primary install command

npm i -g @thevandieg/postx

Prefer a non-npm setup? Read the README on GitHub.

Quick start

Follow this flow for a first successful publish session (connect the channels you use, then compose):

Browse and configure publishing channels (interactive)

postx channels

Compose and publish now or schedule for later

postx post

Current support v1.0.4

Channel availability is distributed with the CLI. Prefer postx channels and per-channel setup flows over hard-coding assumptions in docs.

What to check locally

Run postx --help for the command surface area shipped in your install.
Run postx channels to see what you can configure right now.

Practical limitations depend on the channel (media types, rate limits, auth model). Treat the CLI help output and README as the source of truth for edge cases.

For version-by-version changes, see the release notes

Root command

Running postx --help prints usage, available subcommands, and global flags—mirroring what you see in the terminal.

postx --help
postx is a minimal CLI to compose, schedule, and publish social posts.

Usage:
  postx [command]

Available Commands:
  cancel      Cancel a pending scheduled post
  channels    Browse and configure publishing channels (interactive)
  completion  Generate the autocompletion script for the specified shell
  daemon      Poll for due posts and post them
  flush       Process due posts once (for cron/systemd)
  help        Help about any command
  logout      Remove stored OAuth tokens
  post        Compose a post (interactive)
  status      Calendar view of scheduled posts
  theme       List or set the TUI color theme

Flags:
  -h, --help   help for postx

Use "postx [command] --help" for more information about a command.

Available commands

Each command focuses on one job: composing posts, managing scheduled work, configuring channels, theming, or shell completion.

cancel

Cancel a pending scheduled post

postx cancel --help

channels

Browse and configure publishing channels (interactive)

postx channels --help

completion

Generate the autocompletion script for the specified shell

postx completion --help

daemon

Poll for due posts and post them

postx daemon --help

flush

Process due posts once (for cron/systemd)

postx flush --help

help

Help about any command

postx help --help

logout

Remove stored OAuth tokens

postx logout --help

post

Compose a post (interactive)

postx post --help

status

Calendar view of scheduled posts

postx status --help

theme

List or set the TUI color theme

postx theme --help

Global flags

Flag	Description
-h, --help	Help for postx

Per-command help

For options and examples specific to a subcommand, pass --help after the command name.

postx post --help

postx channels --help