Skip to content

Command reference

Sixteen commands, in five groups. Run sharek --help for the same list, or sharek <command> --help for one command’s flags.

Every command except the three auth:* ones needs credentials first. See sign in.

Creates a post. The single most flag-heavy command.

Flag Alias Required Default What it does
--content -c Yes, unless --json Post content. Repeat it: the first is the post, each one after is a comment or the next part of a thread.
--integrations -i Yes, unless --json Comma-separated channel ids.
--date -s Yes, unless --json Schedule date, ISO 8601.
--media -m No Comma-separated media URLs for the matching -c. Repeat alongside -c.
--type -t No schedule schedule or draft.
--delay -d No 0 Minutes between comments.
--json -j No Path to a JSON file holding the whole post instead of flags.
--shortLink No true Shorten links in the content.
--settings No Platform settings as a JSON string.

A simple scheduled post:

Terminal window
sharek posts:create -c "Our new pricing is live" \
-s "2027-09-01T09:00:00Z" -i "channel-id"

A thread. Note that --date is required here as everywhere, and -d spaces the parts out:

Terminal window
sharek posts:create -c "Thread 1/3" -c "Thread 2/3" -c "Thread 3/3" \
-d 5 -s "2027-09-01T09:00:00Z" -i "channel-id"

Platform settings go in as JSON. Each channel’s settings page, listed under the channels Sharek offers, says what it accepts. The example below is for X:

Terminal window
sharek posts:create -c "Tweet content" -s "2027-09-01T09:00:00Z" \
--settings '{"who_can_reply_post":"everyone"}' -i "channel-id"

For anything elaborate, put the whole post in a file and skip the flags. With --json, the content, channels and date come from the file:

Terminal window
sharek posts:create --json ./post.json

API equivalent: Create a post.

Lists posts. Without dates it covers 30 days back to 30 days forward.

Flag Default What it does
--startDate 30 days ago ISO 8601.
--endDate 30 days from now ISO 8601.
--customer Limit to one brand, by its id.
Terminal window
sharek posts:list --startDate "2026-01-01T00:00:00Z" --endDate "2026-12-31T23:59:59Z"

API equivalent: List posts.

Deletes a post.

Terminal window
sharek posts:delete post-id

API equivalent: Delete a post.

Moves a post between draft and queued. --status (-s) is required and takes draft or schedule.

Terminal window
sharek posts:status post-id --status schedule

Moving a queued post back to draft stops it publishing.

API equivalent: Change post status.

For a published post whose release id Sharek never recorded, this lists what the platform has, so you can identify the right one.

Terminal window
sharek posts:missing post-id

This is the one command that prints bare JSON with no status line above it.

API equivalent: Find missing content.

Records the release id you identified. --release-id is required.

Terminal window
sharek posts:connect post-id --release-id "platform-content-id"

Analytics for that post start working once it is connected.

API equivalent: Update release id.

Lists connected channels with their ids. --group takes a brand id and narrows the list to that brand’s channels.

Terminal window
sharek integrations:list --group "group-id"

API equivalent: List channels.

Lists your brands, with the ids that --group and --customer take. No flags. The flag names follow the API, which calls a brand a group or a customer.

API equivalent: List brands.

Returns what a channel accepts: its rules, character limit, settings schema, and the helper tools available for it. Read this before composing anything platform-specific.

Terminal window
sharek integrations:settings channel-id

API equivalent: Get channel rules and settings schema.

Runs one of the helper tools that integrations:settings listed, which is how you look up ids the settings need. --data (-d) passes arguments as a JSON string.

Terminal window
sharek integrations:trigger channel-id subreddits -d '{"word":"programming"}'

The method names are per platform and case-sensitive. Take them from that channel’s tools array, not from memory.

API equivalent: Trigger a channel tool.

Channel analytics. --date (-d) is the number of days to look back, default 7.

Terminal window
sharek analytics:platform channel-id -d 30

API equivalent: Channel analytics.

Analytics for one post, same --date flag and default.

Terminal window
sharek analytics:post post-id -d 30

If this returns {"missing": true}, the post has no release id yet. Fix it with posts:missing and posts:connect.

API equivalent: Post analytics.

Uploads a file and returns its id and path.

Terminal window
sharek upload ./image.png

API equivalent: Upload a file.

Signs in through the browser. To use a different auth server, which you should not normally need, pass --auth-server or set SHAREK_AUTH_SERVER. The flag wins if you set both.

Reports the method in use and checks the credentials still work.

Closest API equivalent: Check your credentials, which confirms a key works. auth:status itself checks by listing your channels.

Removes the stored credentials.

All three are covered in sign in.