Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo  and the documentation source on GitHub for more information.

Quick demo

LinkFree CLI demo

What is LinkFree CLI?

LinkFree CLI is a command line tool that helps us create a JSON and update an existing JSON file for your LinkFree profile. We can also give testimonials to other LinkFree profiles and add events.

Also the LinkFree CLI is 100% Open Source, you can check it out here.

Installation and using the CLI

  1. Make sure you have forked and cloned the LinkFree repository and have installed the dependencies. Also, make sure you are in the root directory of the project.

  2. To trigger the CLI, run the following command.

npm run cli
  • When we run the above command it will run npx linkfree-cli. We use npx to run the CLI without installing it globally.
  1. You will then be prompted with several options. You can use the arrow keys to navigate and press enter to select the task you want to perform and then you will be prompted with the questions.

LinkFree CLI main prompt

  1. Once you are done with the questions, it will create the JSON file depending on the task you selected. For example, if you selected Create a LinkFree JSON file, it will create a JSON file in the data/ directory. You will also get a message in the terminal. Something similar to the following image.

LinkFree CLI JSON file created

  1. Once the JSON file is created by the CLI, you can commit the changes by the commit message that starts with data: followed by your GitHub username (for example, data: Pradumnasaraf). Then you can push the changes to your forked repository and create a pull request.

Feedback

If you find any kind of bug you can use the 5th option 🐛 Report a bug in the main prompt to report the bug. You can also create an issue in the LinkFree CLI repository.