Usage for X (formerly Twitter)¶
Note
New in version 2.0: X commands now use the intuitive agoras x format.
See the migration guide for upgrading from agoras publish.
Deprecated since version 2.0: The agoras twitter command is deprecated. Use agoras x instead.
X (formerly Twitter) is a social network that allows you to publish short messages (called tweets) of up to 280 characters. Agoras provides full CLI support for posting, liking, sharing, and managing X content.
Important: X now requires a paid subscription for certain parts of the API. The free tier will let you publish and delete X posts, but may have limitations on likes or retweets depending on your API access level.
Available Actions¶
authorize- Set up OAuth 1.0a authentication (required first step)post- Create text and image tweets (up to 4 images)video- Upload videoslike- Like tweetsshare- Retweet/share tweetsdelete- Delete your own tweets
Quick Start¶
See all X commands:
agoras x --help
Note
The agoras twitter command still works for backward compatibility but shows a deprecation warning. Use agoras x instead.
Post a Tweet¶
New format (Agoras 2.0+):
agoras x post \
--consumer-key "${TWITTER_CONSUMER_KEY}" \
--consumer-secret "${TWITTER_CONSUMER_SECRET}" \
--text "${STATUS_TEXT}" \
--image-1 "${IMAGE_URL_1}" \
--image-2 "${IMAGE_URL_2}"
Note
You must run agoras x authorize first before using this command.
Like a Tweet¶
New format:
agoras x like \
--consumer-key "${TWITTER_CONSUMER_KEY}" \
--consumer-secret "${TWITTER_CONSUMER_SECRET}" \
--post-id "${TWEET_ID}"
Note
You must run agoras x authorize first before using this command.
Delete a Tweet¶
New format:
agoras x delete \
--consumer-key "${TWITTER_CONSUMER_KEY}" \
--consumer-secret "${TWITTER_CONSUMER_SECRET}" \
--post-id "${TWEET_ID}"
Note
You must run agoras x authorize first before using this command.
Upload a Video¶
New format:
agoras x video \
--consumer-key "${TWITTER_CONSUMER_KEY}" \
--consumer-secret "${TWITTER_CONSUMER_SECRET}" \
--video-url "${VIDEO_URL}" \
--video-title "${VIDEO_TITLE}"
Note
You must run agoras x authorize first before using this command.
Feed Automation¶
Publish the last URL from an RSS feed to X:
agoras utils feed-publish \
--network x \
--mode last \
--feed-url "${FEED_URL}" \
--max-count "${MAX_COUNT}" \
--post-lookback "${POST_LOOKBACK}" \
--x-consumer-key "${TWITTER_CONSUMER_KEY}" \
--x-consumer-secret "${TWITTER_CONSUMER_SECRET}"
Note
You must run agoras x authorize first before using this command.
Note
The --network twitter and --twitter-* parameters are deprecated. Use --network x and --x-* parameters instead.
See RSS feed section for more details on feed automation.
Post a random URL from an RSS feed into X¶
This command will parse an RSS feed at --feed-url and publish one random entry that’s not older than --max-post-age. The post content will consist of the title and the link of the feed entry. The post will be published using the X account that’s authorized by the provided credentials (read about how to get credentials here).
Note
You must run agoras x authorize first before using this command.
Please read about how the RSS feed should be structured in the RSS feed section. This ensures that the feed is correctly parsed and that the post content is properly formatted.
New format (Agoras 2.0+):
agoras utils feed-publish \
--network x \
--mode random \
--feed-url "${FEED_URL}" \
--max-post-age "${MAX_POST_AGE}" \
--x-consumer-key "${TWITTER_CONSUMER_KEY}" \
--x-consumer-secret "${TWITTER_CONSUMER_SECRET}"
Note
The --network twitter and --twitter-* parameters are deprecated. Use --network x and --x-* parameters instead.
Schedule an X post¶
This command will scan a sheet --sheets-name of a Google spreadsheet of id --sheets-id, that’s authorized by --sheets-client-email and --sheets-private-key. The post will be published using the X account that’s authorized by the provided credentials (read about how to get credentials here).
Note
You must run agoras x authorize first before using this command.
The order of the columns of the spreadsheet is crucial to the correct functioning of the command. Here’s how the information should be organized:
|
|
|
|
|
|
date (%d-%m-%Y format) |
time (%H format) |
status (draft or published) |
As you can see, the first 6 columns correspond to the parameters of the “post” command, the date and time columns correspond to the specific time that you want to publish this post, and the status column tells the script if this post is ready to be published (draft status) or if it was already published and should be skipped (published status). Let’s see an example of a working schedule:
This is a test X post |
21-11-2022 |
17 |
draft |
This schedule entry would be published at 17:00h of 21-11-2022 with text “This is a test X post” and 4 images pointed by those URLs.
For this command to work, it should be executed hourly by a cron script.
New format (Agoras 2.0+):
agoras utils schedule-run \
--network x \
--sheets-id "${GOOGLE_SHEETS_ID}" \
--sheets-name "${GOOGLE_SHEETS_NAME}" \
--sheets-client-email "${GOOGLE_SHEETS_CLIENT_EMAIL}" \
--sheets-private-key "${GOOGLE_SHEETS_PRIVATE_KEY}" \
--x-consumer-key "${TWITTER_CONSUMER_KEY}" \
--x-consumer-secret "${TWITTER_CONSUMER_SECRET}"
How to get --tweet-id parameter¶
Extracting from X website¶
The tweet ID parameter is necessary to delete tweets. You can extract it from the tweet URL:
https://twitter.com/XXXXX/status/NNNNNNNNNNN
NNNNNNNNNNN is the tweet ID.
Using Agoras¶
When you create an X post with Agoras, it will print the post ID (in json format) in the console. You can copy it from there and use it in other commands. For example:
$ agoras x post \
--consumer-key XXXXX \
--consumer-secret XXXXX \
--text "This is a test post"
$ {"id":"NNNNNNNNNNN"}
NNNNNNNNNNN is the post ID.
