Musket

With Musket a “shooter” “fires” a URL at a “target” :D.

Musket is a command line interface to send a URL to several destinations. Each destination handle the URL depending the nature of the destination, for example, Bluesky, Mastodon and LinkedIn destinations post the URL in the user's feed whereas Turso destination stores the URL in Turso Service (a SQLite database SaaS).

Usage

1.- Install

For a while, Musket is provided as a cargo package, therefore you need cargo installed in your machine.

cargo install musket

Dependencies

Due to cargo install download, compile and build Musket some dependencies must be installed in your machine.

For an Ubuntu 24.04:

$ sudo apt install build-essential pkg-config libssl-dev

Other GNU/Linux distros have to change the package manager (like dnf, pacman, etc) and the package names.

Necessary dependencies for other operating systems are pending investigation.

2.- Create the configuration file

To create the configuration file, execute:

$ musket init

Musket uses a configuration file named config.toml. This file is placed in the directory musket inside the users's home. This home depends of the operating system:

• GNU/Linux
• MS Windows
• macOS

The musket init command will display the full path to the configuration file.

3.- Configure the destinations

All destinations have to be configured from the configuration file. The configuration is a .toml file, therefore, strings must be in quotes and booleans must be the word true or false.

Bluesky

Before sending a URL to Bluesky destination you must:

1. Create a Bluesky account. For a while, Musket only suports the Bluesky Social provider.
2. Fill the bluesky section in the Musket configuration file. You must provide:
   • the identifier is the account's username or email.
   • the password of the account.
   • commentary is the default text that will be shown in the post along the link.
   • language is the language of the commentary.
   • enabled to set whether the destination can be selected.

Mastodon

Before sending a URL to Mastodon destination you must:

1. Create a Mastodon account.
2. Create a Mastodon Application with the Write and Profile scopes added. Once the Application has been created an access token will be generated.
3. Fill the mastodon section in the Musket configuration file. You must provide:
   • the server is the URL of your Mastodon account provider, for example: https://mastodon.online.
   • the token used as a authentication.
   • commentary is the default text that will be shown in the post along the link.
   • language is the language of the commentary.
   • enabled to set whether the destination can be selected.

LinkedIn

Before sending a URL to LinkedIn destination you must:

1. Create a LinkedIn Application with the Share on LinkedIn and Sign In with LinkedIn using OpenID Connect products added to the application.
2. Create an access token with the email, openid, profile, w_member_social permissions.
3. Get the author identifier (doing a request to the userinfo endpoint using the access token).
4. Fill the linkedin section in the Musket configuration file. You must provide:
   • the token used as a bearer authentication.
   • the author identifier.
   • commentary is the default text that will be shown in the post along the link.
   • language is the language of the commentary.
   • visibility, can be "PUBLIC" or "CONNECTIONS".
   • enabled to set whether the destination can be selected.

Turso

Before sending a URL to Turso destination you must:

1. Create a Turso account.
2. Create a Turso Database.
3. Create a Table with the following schema:

CREATE TABLE links (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  url TEXT,
  tags TEXT,
  created DATETIME
);

4. Fill the turso section in the Musket configuration file. You must provide:
   • the url of the database where store the data.
   • the token used as a authentication.
   • enabled to set whether the destination can be selected.

4.- Configure the sources

One way to specify a URL is to get it from the sources instead of setting it directly. Currently, Musket only supports Instapaper as a valid source.

Instapaper

Before getting a URL from Instapaper you must:

1. Create a Instapaper account.
2. Request a New OAuth Application.
3. Fill the instapaper section in the Musket configuration file. You must provide:
   • the username used as a part of the credentials of your account.
   • the password used as a part of the credentials of your account.
   • the consumer_key provided by Instapaper after the New OAuth Application request.
   • consumer_secret provided by Instapaper after the New OAuth Application request.

Here's how Musket works with Instapaper:

• Musket only sends to the destinations one Instapaper bookmark at a time.
• Musket only sends to the destinations Instapaper bookmarks with the tag musket.
• Once the bookmark is sent to the destinations, Musket deletes it from Instapaper.

5.- Using the CLI

Run musket -h to get the details of each command and option.

Init command

Use this command to initialize Musket creating the configuration file:

$ musket init

The init command have one options:

• -f, --force: Use this option to create the configuration file by overwriting the existing one.

Fire command

Use this command to send a URL:

$ musket fire

The fire command have several options:

• -u, --url: Use this option to set the URL to send to the destinations. Url is mandatory if -f, --from is not present.
• -f, --from: Use this option to set from where the URL to send to the destinations should be obtained. From is mandatory if -u, --url is not present.
• -d, --destination: Use this option to set where the URL will be send. At least, one destination must be specified.
• -t, --tags: Use this option to set the tags to be used in the destinations. Tags are optional. If -f, --from is present, the tags used will be the tags set in the source.
• -c, --commentary: Use this option to set the text that will be published along with the URL. Commentary is optional. If no text is specified, then the text set in the configuration file will be used. Turso destination not uses commentaries.
• -l, --language: Use this option to set the language of the commentary. Language is optional. If no language is specified, then the language set in the configuration file will be used. Turso destination not uses language. The language must be use ISO 639-1 language tag. That means, use two letters, like en for English, es for Spanish, etc.

$ musket fire --url <URL> --from <SOURCE> --destination <DESTINATION> --tags <tags> --commentary <text> --language <text>

For example:

$ musket fire --url wikipedia.org --destination bluesky,mastodon,linked-in,turso --tags one,two,three --commentary "I've just discover this amazing website!" --language en

or

$ musket fire --url wikipedia.org -d bluesky -d mastodon -d linked-in -d turso -t one -t two -t three -c "I've just discover this amazing website!" -l en

or

$ musket fire --source instapaper --destination all --commentary "I've just discover this amazing website!" --language en

Logging

By default, errors and information messages will be displayed on the terminal to be notified about the result of the Musket execution. If you want to see the debug messages you must set the RUST_LOG environment variable with the value debug. For example adding it before a Musket execution command:

$ RUST_LOG="debug" musket fire --url wikipedia.org -d bluesky -d mastodon -d linked-in -d turso -t one -t two -t three -c "I've just discover this amazing website!"

Contributing

If you want to contribute to Musket, please read the CONTRIBUTING.md document.