Musket

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, Turso destination stores the URL in Turso Service (a SQLite database SaaS) and LinkedIn destination publish the link in the user profile.

Usage

1.- Install

cargo install musket

2.- Create the configuration file

To create the configuration file, execute:

$ musket load

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 load command will display the full path to the configuration file.

3.- Configure the destinations

All destinations have to be configured from the configuration file.

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.
   • share_commentary is the text that will be shown in the post along the link.
   • visibility, can be "PUBLIC" or "CONNECTIONS".

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 database url and the turso token.

4.- Sending a URL

$ musket fire --url <URL> --destination <DESTINATION> --tags <tags>

For example:

$ musket fire --url wikipedia.org --destination linked-in,turso --tags one,two,three

or

$ musket fire --url wikipedia.org -d linked-in -d turso -t one -t two -t three

Run musket -h to get the details of each subcommand and arguments.

Contributing

Requirements

Last stable Rust toolchain. Use Rustup to install it.

Guidelines

• Use Conventional Commits.
• Use Feature Branch creating a pull request to main.
• Use Semantic Versioning.

Adding destinations

To add new destinations you must follow the next steps:

Info: Use the existing destinations code files as a source of information.

1. Define the configuration

In the config.rs file, add a struct to define the new destination configuration.

For example:

#[derive(Default, Debug, Serialize, Deserialize)]
pub struct TursoConfiguration {
    pub url: String,
    pub token: String,
}

Add a field in the Configuration struct with the destination as a name and the destination configuration as a type:

#[derive(Default, Debug, Serialize, Deserialize)]
pub struct Configuration {
    pub linkedin: LinkedinConfiguration,
    pub turso: TursoConfiguration,
    // Add here the new destination configuration
}

2. Create a module

Create a file with the name of the new destination inside destinations folder.

This file must:

1. have a public struct with the fields needed to configure the destination. This fields must be pub.
2. implement Destination trait.
3. implement From trait for DestinationError.

Once created, add the new module as a public module in the destination module inside the mod.rs file.

For example:

pub mod linkedin;
pub mod turso;

3. Manage new destination from the CLI

In the cli.rs file, add the new destination as a variant of the enum Destinations.

pub enum Destinations {
    All,
    LinkedIn,
    Turso,
    // Add here the new destination
}

4. Create a Command

Create a file with the name of the new destination inside commands folder.

This file must implement a function named execute in charge of perform the sending of the URL (and tags if needed) to the destination.

Once created, add the new module as a public module in the commands module inside the mod.rs file.

For example:

pub mod linkedin;
pub mod turso;

5. Manage new destination from the lib

In the ['lib.rs](./src/lib.rs) file, add the new destination as a pattern matching of the Firecommand, and add a call to the command created above. Remember to add the command to theDestinations::All` match.

For example:

Destinations::All => {
    turso::execute(&cfg, &url, &vector_of_tags).await?;
    linkedin::execute(&cfg, &url, &vector_of_tags).await?;
}
Destinations::Turso => {
    turso::execute(&cfg, &url, &vector_of_tags).await?;
}
Destinations::LinkedIn => {
    linkedin::execute(&cfg, &url, &vector_of_tags).await?;
}

6. Update the documentation

In the README.md file, add a documentation about how to configure the new destination inside the section Configure the destinations.