CLI Reference
This page is generated from the Cobra command tree. Do not edit it by hand.
Regenerate with:
cd cli && go run ./cmd/openpost-docs ../docs-site/reference/cli.mdopenpost
OpenPost CLI — control a self-hosted OpenPost instance from the terminal
openpost is a command-line client for the OpenPost social media scheduler. It talks to a running OpenPost instance over HTTPS, authenticates with a revocable API token, and exposes the most common posting, scheduling, account, and media workflows for use from scripts, CI, and power-user shells.
Usage
openpost [flags]Flags
| Flag | Default | Description |
|---|---|---|
-h, --help | false | help for openpost |
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
-v, --version | false | version for openpost |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost account | Manage connected social accounts |
openpost auth | Authenticate with an OpenPost instance |
openpost completion | Generate shell completion script |
openpost instance | Manage OpenPost instance profiles |
openpost jobs | List background jobs |
openpost media | Upload and list media attachments |
openpost post | Create, list, view, update, and delete posts |
openpost set | Manage workspace social sets |
openpost thread | Create multi-post threads |
openpost version | Print the openpost CLI version |
openpost workspace | Manage the active OpenPost workspace |
openpost account
Manage connected social accounts
List, rename, and disconnect social accounts. Account slugs are the preferred selector for --accounts. New accounts are connected in the OpenPost web UI at <instance>/accounts.
Usage
openpost accountInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost account disconnect | Disconnect a social account |
openpost account list | List connected social accounts |
openpost account rename | Rename a social account slug |
openpost account disconnect
Disconnect a social account
Usage
openpost account disconnect <account-id>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost account list
List connected social accounts
List connected social accounts for the active workspace. Use the SLUG column as the preferred selector for --accounts and account rename.
Usage
openpost account list [flags]Flags
| Flag | Default | Description |
|---|---|---|
--platform | - | filter by platform |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost account rename
Rename a social account slug
Rename a connected account's slug. The selector can be an account id, slug, platform:username value, bare platform when unambiguous, or mastodon host.
Usage
openpost account rename <selector> --slug <new-slug> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--slug | - | new account slug |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost auth
Authenticate with an OpenPost instance
Usage
openpost authInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost auth login | Log in to an OpenPost instance |
openpost auth logout | Delete the stored token for the active profile |
openpost auth status | Show authentication status for the active profile |
openpost auth token | Manage API tokens |
openpost auth login
Log in to an OpenPost instance
Usage
openpost auth login <instance> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--device | false | print the device code and poll without opening a browser |
--insecure-storage | false | store the token in credentials.json instead of the OS keyring |
--no-browser | false | skip automatically opening the browser |
--with-token | false | read a raw API token from stdin |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost auth logout
Delete the stored token for the active profile
Usage
openpost auth logoutInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost auth status
Show authentication status for the active profile
Usage
openpost auth statusInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost auth token
Manage API tokens
Usage
openpost auth tokenInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost auth token list | List API tokens |
openpost auth token revoke | Revoke an API token |
openpost auth token list
List API tokens
Usage
openpost auth token listInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost auth token revoke
Revoke an API token
Usage
openpost auth token revoke <id>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost completion
Generate shell completion script
Output a shell completion script for the given shell. To load completions: Bash: $ source <(openpost completion bash) # To load completions for each session, execute once: # Linux: $ openpost completion bash > /etc/bash_completion.d/openpost # macOS: $ openpost completion bash > $(brew --prefix)/etc/bash_completion.d/openpost Zsh: # If shell completion is not already enabled in your environment, # you will need to enable it. You can execute the following once: $ echo "autoload -U compinit; compinit" >> ~/.zshrc # To load completions for each session, execute once: $ openpost completion zsh > "${fpath[1]}/_openpost" # You will need to start a new shell for this setup to take effect. Fish: $ openpost completion fish | source # To load completions for each session, execute once: $ openpost completion fish > ~/.config/fish/completions/openpost.fish PowerShell: PS> openpost completion powershell | Out-String | Invoke-Expression # To load completions for every new session, run: PS> openpost completion powershell > openpost.ps1 # and source this file from your PowerShell profile.
Usage
openpost completion <bash\|zsh\|fish\|powershell>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost instance
Manage OpenPost instance profiles
Usage
openpost instanceInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost instance add | Add or update an instance profile |
openpost instance list | List configured instances |
openpost instance remove | Remove an instance profile |
openpost instance use | Set the active instance profile |
openpost instance add
Add or update an instance profile
Usage
openpost instance add <name> <url>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost instance list
List configured instances
Usage
openpost instance listInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost instance remove
Remove an instance profile
Usage
openpost instance remove <name>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost instance use
Set the active instance profile
Usage
openpost instance use <name>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost jobs
List background jobs
Usage
openpost jobsInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost jobs list | List background jobs |
openpost jobs list
List background jobs
Usage
openpost jobs list [flags]Flags
| Flag | Default | Description |
|---|---|---|
--limit | 0 | maximum number of jobs to return |
--status | - | filter by status: pending, failed, completed |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost media
Upload and list media attachments
Usage
openpost mediaInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost media list | List media attachments |
openpost media upload | Upload a media file |
openpost media list
List media attachments
Usage
openpost media list [flags]Flags
| Flag | Default | Description |
|---|---|---|
--limit | 0 | maximum number of media items to return |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost media upload
Upload a media file
Usage
openpost media upload <file> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--alt | - | alt text for the uploaded media |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost post
Create, list, view, update, and delete posts
Usage
openpost postInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost post create | Create a draft or scheduled post |
openpost post delete | Delete a draft or scheduled post |
openpost post list | List posts |
openpost post update | Update a draft or scheduled post |
openpost post view | View a post |
openpost post create
Create a draft or scheduled post
Usage
openpost post create [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors |
--content | - | post content |
--file | - | read post content from a file |
--media | [] | media id or local file path; repeatable |
--media-alt | [] | alt text for the matching uploaded --media |
--random-delay | 0 | random delay in minutes |
--schedule | - | natural-language, RFC3339, next-slot, now, or draft |
--set | - | social set name or ID to publish to |
--thread-draft | - | encoded thread draft to attach |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost post delete
Delete a draft or scheduled post
Usage
openpost post delete <post-id>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost post list
List posts
Usage
openpost post list [flags]Flags
| Flag | Default | Description |
|---|---|---|
--limit | 0 | maximum number of posts to return |
--status | - | filter by status: draft, scheduled, published, failed |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost post update
Update a draft or scheduled post
Usage
openpost post update <post-id> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors |
--content | - | post content |
--random-delay | 0 | random delay in minutes |
--schedule | - | natural-language, RFC3339, next-slot, now, or draft; empty string unschedules |
--set | - | social set name or ID to publish to |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost post view
View a post
Usage
openpost post view <post-id>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set
Manage workspace social sets
Manage workspace social sets: reusable groups of social accounts. Posts and threads use the workspace default set when neither --accounts nor --set is passed.
Usage
openpost setInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost set add | Add accounts to a social set |
openpost set create | Create a social set |
openpost set default | Set or clear the workspace default social set |
openpost set delete | Delete a social set |
openpost set list | List social sets |
openpost set remove | Remove accounts from a social set |
openpost set rename | Rename a social set |
openpost set add
Add accounts to a social set
Usage
openpost set add <set> --accounts <selectors> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors to add |
--main | false | mark added accounts as main accounts |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set create
Create a social set
Usage
openpost set create <name> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors to include |
--default | false | make this the workspace default set |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set default
Set or clear the workspace default social set
Usage
openpost set default <set> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--unset | false | clear default status instead of making the set default |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set delete
Delete a social set
Usage
openpost set delete <set>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set list
List social sets
Usage
openpost set listInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set remove
Remove accounts from a social set
Usage
openpost set remove <set> --accounts <selectors> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors to remove |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost set rename
Rename a social set
Usage
openpost set rename <set> <name>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost thread
Create multi-post threads
Usage
openpost threadInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost thread create | Create a thread from a markdown file |
openpost thread create
Create a thread from a markdown file
Usage
openpost thread create <file> [flags]Flags
| Flag | Default | Description |
|---|---|---|
--accounts | - | comma-separated account selectors |
--random-delay | 0 | random delay in minutes |
--schedule | - | natural-language, RFC3339, next-slot, now, or draft |
--set | - | social set name or ID to publish to |
Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost version
Print the openpost CLI version
Usage
openpost versionInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost workspace
Manage the active OpenPost workspace
Usage
openpost workspaceInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
Subcommands
| Command | Description |
|---|---|
openpost workspace create | Create a workspace |
openpost workspace list | List workspaces |
openpost workspace use | Set the active workspace for the current profile |
openpost workspace create
Create a workspace
Usage
openpost workspace create <name>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost workspace list
List workspaces
Usage
openpost workspace listInherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |
openpost workspace use
Set the active workspace for the current profile
Usage
openpost workspace use <name-or-id>Inherited Flags
| Flag | Default | Description |
|---|---|---|
--instance | - | OpenPost instance URL (default: profile or $OPENPOST_INSTANCE) |
--json | false | emit machine-readable JSON instead of tables/prose |
--no-color | false | disable ANSI colors |
--profile | - | profile name from config (default: $OPENPOST_PROFILE or 'default') |
--quiet | false | suppress non-error output |
--token | - | API token override (default: keyring or $OPENPOST_TOKEN) |
--workspace | - | workspace name or ID (default: profile or $OPENPOST_WORKSPACE) |
--yes | false | skip interactive confirmations |