https://github.com/fleek-platform/cli
The Fleek-platform CLI provides a unified command line interface to Fleek Services
https://github.com/fleek-platform/cli
Last synced: 4 months ago
JSON representation
The Fleek-platform CLI provides a unified command line interface to Fleek Services
- Host: GitHub
- URL: https://github.com/fleek-platform/cli
- Owner: fleek-platform
- License: mit
- Created: 2024-06-19T17:35:52.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-08-30T16:17:58.000Z (10 months ago)
- Last Synced: 2025-08-30T18:17:26.208Z (10 months ago)
- Language: TypeScript
- Size: 3.57 MB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡️Fleek-Platform CLI ⚡️
[](https://conventionalcommits.org)
[](https://opensource.org/licenses/MIT)
Fleek CLI provides a unified command line interface to Fleek Services.
## Overview
* [🤖 Install](#install)
* [👷♀️Development](#development)
- [Code format](#code-format)
- [Changeset](#changeset)
* [📖 Docs](https://fleek.xyz/docs)
* [🙏 Contributing](#contributing)
- [Branching strategy](#branching-strategy)
- [Contributing](#conventional-commits)
* [⏱️ Changelog](./CHANGELOG.md)
## 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](https://nodejs.org/en/download). Next, run the following command to globally install our CLI tool:
```sh
# Install globally (recommended)
npm i -g @fleek-platform/cli
```
⚠️ If you're planning to contribute as a developer, you must install [pnpm](https://pnpm.io), otherwise most commands will fail.
For a quick start, learn the [basic commands](#basic-commands), or alternatively visit our [documentation](https://fleek.xyz/docs)
## Development
For developers looking to contribute to the CLI tool itself, [clone](https://github.com/fleekxyz/cli) the repository and follow the [contribution guide](#contributing).
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](https://nodejs.org/en/download) and [PNPM](https://pnpm.io/installation) 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.
```sh
touch .env.production
```
Open the .env.production file in a text editor and add the following:
```sh
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:
```sh
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:
```sh
pnpm link -g
```
Everytime you prepare and save a change, you have to rebuild the binary:
```sh
pnpm build
```
You can call the global binary named `fleek`.
```sh
fleek
```
Learn the Fleek-platform CLI basic commands [here](#basic-commands). For extended documentation visit our [documentation site](https://fleek.xyz/docs).
### Code Format
Formatting and linting are facilitated by [BiomeJS](https://biomejs.dev). Configuration details can be found in:
```
biome.json
```
To format source code and apply changes directly in the file:
```sh
pnpm format
```
For checking source code formatting only:
```sh
pnpm format:check
```
To lint and apply changes directly in the file:
```sh
pnpm lint
```
For lint checks only:
```sh
pnpm lint:check
```
To both format and lint source code (with writes):
```sh
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:
```sh
pnpm changeset:add
```
## Basic commands
The Fleek CLI command has the following structure:
```bash
fleek [options and parameters]
```
To view all available services and commands use:
```bash
fleek help
```
To see all available commands for a service, use the help documentation as any one of the followings:
```bash
fleek help
fleek help
```
To get the version of the Fleek CLI:
```bash
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:
1. Fork the project [here](https://github.com/fleekxyz/cli)
2. Create your feature branch using our [branching strategy](#branching-strategy), e.g. `git checkout -b feat/my-new-feature`
3. Run the tests: `pnpm test`
4. Commit your changes by following our [commit conventions](#conventional-commits), e.g. `git commit -m 'chore: 🤖 my contribution description'`
5. Push to the branch, e.g. `git push origin feat/my-new-feature`
6. 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).
### Conventional commits
We prefer to commit our work following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) 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:
```txt
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...
```