⚡️Fleek-Platform CLI ⚡️

Fleek CLI provides a unified command line interface to Fleek Services.

Overview

🤖 Install
👷‍♀️Development
- Code format
- Changeset
📖 Docs
🙏 Contributing
- Branching strategy
- Contributing
⏱️ Changelog

Requirements

Nodejs as runtime
NPM, Yarn to install the CLI as a client, or PNPM for development
Familiarity with text-based user interfaces, command-line interface (CLI)

Install

To install and use the CLI as a client or end-user, open your terminal and follow these simple steps. First, ensure you have Node.js installed on your system. If not, download and install it here. Next, run the following command to globally install our CLI tool:

# Install globally (recommended)
npm i -g @fleek-platform/cli

⚠️ If you're planning to contribute as a developer, you must install pnpm, otherwise most commands will fail.

For a quick start, learn the basic commands, or alternatively visit our documentation

Development

For developers looking to contribute to the CLI tool itself, clone the repository and follow the contribution guide.

Once cloned, you'll have to set up the local development environment, e.g. to have access to the source-code, iterate, run tests and much more.

For runtime we utilize Nodejs and PNPM as the package manager.

Create a new file named .env in the root directory of your project. This file will store environment variables needed for local development.

touch .env.production

Open the .env.production file in a text editor and add the following:

IPFS_GATEWAY_HOSTNAME="gateway-ipfs.fleek.xyz"
SDK__AUTH_APPS_URL="https://auth-apps.service.fleek.xyz"
SDK__GRAPHQL_API_URL="https://graphql.service.fleek.xyz/graphql"
SDK__IPFS__STORAGE_API_URL="https://storage-ipfs.service.fleek.xyz"
SDK__UPLOAD_PROXY_API_URL="https://uploads.service.fleek.xyz"
SITE_SLUG_DOMAIN="on-fleek.app"
UI__APP_URL="https://app.fleek.xyz"

💡 The variables above point to our production environment, the same you interact with as an end-user.

Next, install the project dependencies:

pnpm i

Next, prepare your local changes and execute the commands to compute it.

In order to succeed, you're required to have the ability to execute commands in the binary, so we'll link the local package globally in your local system, as follows:

pnpm link -g

Everytime you prepare and save a change, you have to rebuild the binary:

pnpm build

You can call the global binary named fleek.

fleek

Learn the Fleek-platform CLI basic commands here. For extended documentation visit our documentation site.

Code Format

Formatting and linting are facilitated by BiomeJS. Configuration details can be found in:

biome.json

To format source code and apply changes directly in the file:

pnpm format

For checking source code formatting only:

pnpm format:check

To lint and apply changes directly in the file:

pnpm lint

For lint checks only:

pnpm lint:check

To both format and lint source code (with writes):

pnpm format:unsafe

Changeset

Manage the versioning of changelog entries.

Declare an intent to release by executing the command and answering the wizard's questions:

pnpm changeset:add

Basic commands

The Fleek CLI command has the following structure:

fleek <service> <command> [options and parameters]

To view all available services and commands use:

fleek help

To see all available commands for a service, use the help documentation as any one of the followings:

fleek <service> help
fleek <service> <command> help

To get the version of the Fleek CLI:

fleek --version

Contributing

This section guides you through the process of contributing to our open-source project. From creating a feature branch to submitting a pull request, get started by:

Fork the project here
Create your feature branch using our branching strategy, e.g. git checkout -b feat/my-new-feature
Run the tests: pnpm test
Commit your changes by following our commit conventions, e.g. git commit -m 'chore: 🤖 my contribution description'
Push to the branch, e.g. git push origin feat/my-new-feature
Create new Pull Request following the corresponding template guidelines

Branching strategy

The develop branch serves as the main integration branch for features, enhancements, and fixes. It is always in a deployable state and represents the latest development version of the application.

Feature branches are created from the develop branch and are used to develop new features or enhancements. They should be named according to the type of work being done and the scope of the feature and in accordance with conventional commits here.

Conventional commits

We prefer to commit our work following Conventional Commits conventions. Conventional Commits are a simple way to write commit messages that both people and computers can understand. It help us keep track fo changes in a consistent manner, making it easier to see what was added, changed, or fixed in each commit or update.

The commit messages are formatted as [type]/[scope] The type is a short descriptor indicating the nature of the work (e.g., feat, fix, docs, style, refactor, test, chore). This follows the conventional commit types.

The scope is a more detailed description of the feature or fix. This could be the component or part of the codebase affected by the change.

Here's an example of different conventional commits messages that you should follow:

test: 💍 Adding missing tests
feat: 🎸 A new feature
fix: 🐛 A bug fix
chore: 🤖 Build process or auxiliary tool changes
docs: 📝 Documentation only changes
refactor: 💡 A code change that neither fixes a bug or adds a feature
style: 💄 Markup, white-space, formatting, missing semi-colons...