{"id":44974224,"url":"https://github.com/fleek-platform/cli","last_synced_at":"2026-02-18T16:30:35.528Z","repository":{"id":259866993,"uuid":"817431874","full_name":"fleek-platform/cli","owner":"fleek-platform","description":"The Fleek-platform CLI provides a unified command line interface to Fleek Services","archived":false,"fork":false,"pushed_at":"2025-08-30T16:17:58.000Z","size":3743,"stargazers_count":3,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-08-30T18:17:26.208Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fleek-platform.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-19T17:35:52.000Z","updated_at":"2025-08-30T16:08:46.000Z","dependencies_parsed_at":"2024-10-28T14:24:06.939Z","dependency_job_id":"c17c7c0e-b927-433f-ab54-9498789a39e7","html_url":"https://github.com/fleek-platform/cli","commit_stats":null,"previous_names":["fleek-platform/cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fleek-platform/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fleek-platform","download_url":"https://codeload.github.com/fleek-platform/cli/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29585532,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T13:56:48.962Z","status":"ssl_error","status_checked_at":"2026-02-18T13:54:34.145Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-18T16:30:35.289Z","updated_at":"2026-02-18T16:30:35.509Z","avatar_url":"https://github.com/fleek-platform.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](.repo/images/repo/banner.png?202409201714)\n\n# ⚡️Fleek-Platform CLI ⚡️\n\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-blue.svg)](https://conventionalcommits.org)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![Tests](https://github.com/fleek-platform/cli/actions/workflows/test-runner.yml/badge.svg)\n\nFleek CLI provides a unified command line interface to Fleek Services.\n\n## Overview\n\n* [🤖 Install](#install)\n* [👷‍♀️Development](#development)\n  - [Code format](#code-format)\n  - [Changeset](#changeset)\n* [📖 Docs](https://fleek.xyz/docs)\n* [🙏 Contributing](#contributing)\n  - [Branching strategy](#branching-strategy)\n  - [Contributing](#conventional-commits)\n* [⏱️ Changelog](./CHANGELOG.md)\n\n## Requirements\n\n- Nodejs as runtime\n- NPM, Yarn to install the CLI as a client, or PNPM for development\n- Familiarity with text-based user interfaces, command-line interface (CLI)\n\n## Install\n\nTo 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:\n\n```sh\n# Install globally (recommended)\nnpm i -g @fleek-platform/cli\n```\n\n⚠️ If you're planning to contribute as a developer, you must install [pnpm](https://pnpm.io), otherwise most commands will fail.\n\nFor a quick start, learn the [basic commands](#basic-commands), or alternatively visit our [documentation](https://fleek.xyz/docs)\n\n## Development\n\nFor developers looking to contribute to the CLI tool itself, [clone](https://github.com/fleekxyz/cli) the repository and follow the [contribution guide](#contributing).\n\nOnce 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.\n\nFor runtime we utilize [Nodejs](https://nodejs.org/en/download) and [PNPM](https://pnpm.io/installation) as the package manager.\n\nCreate a new file named .env in the root directory of your project. This file will store environment variables needed for local development.\n\n```sh\ntouch .env.production\n```\n\nOpen the .env.production file in a text editor and add the following:\n\n```sh\nIPFS_GATEWAY_HOSTNAME=\"gateway-ipfs.fleek.xyz\"\nSDK__AUTH_APPS_URL=\"https://auth-apps.service.fleek.xyz\"\nSDK__GRAPHQL_API_URL=\"https://graphql.service.fleek.xyz/graphql\"\nSDK__IPFS__STORAGE_API_URL=\"https://storage-ipfs.service.fleek.xyz\"\nSDK__UPLOAD_PROXY_API_URL=\"https://uploads.service.fleek.xyz\"\nSITE_SLUG_DOMAIN=\"on-fleek.app\"\nUI__APP_URL=\"https://app.fleek.xyz\"\n```\n\n💡 The variables above point to our production environment, the same you interact with as an end-user.\n\nNext, install the project dependencies:\n\n```sh\npnpm i\n```\n\nNext, prepare your local changes and execute the commands to compute it.\n\nIn 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:\n\n```sh\npnpm link -g\n```\n\nEverytime you prepare and save a change, you have to rebuild the binary:\n\n```sh\npnpm build\n```\n\nYou can call the global binary named `fleek`.\n\n```sh\nfleek\n```\n\nLearn the Fleek-platform CLI basic commands [here](#basic-commands). For extended documentation visit our [documentation site](https://fleek.xyz/docs).\n\n### Code Format\n\nFormatting and linting are facilitated by [BiomeJS](https://biomejs.dev). Configuration details can be found in:\n\n```\nbiome.json\n```\n\nTo format source code and apply changes directly in the file:\n\n```sh\npnpm format\n```\n\nFor checking source code formatting only:\n\n```sh\npnpm format:check\n```\n\nTo lint and apply changes directly in the file:\n\n```sh\npnpm lint\n```\n\nFor lint checks only:\n\n```sh\npnpm lint:check\n```\n\nTo both format and lint source code (with writes):\n\n```sh\npnpm format:unsafe\n```\n\n### Changeset\n\nManage the versioning of changelog entries.\n\nDeclare an intent to release by executing the command and answering the wizard's questions:\n\n```sh\npnpm changeset:add\n```\n\n## Basic commands\n\nThe Fleek CLI command has the following structure:\n\n```bash\nfleek \u003cservice\u003e \u003ccommand\u003e [options and parameters]\n```\n\nTo view all available services and commands use:\n\n```bash\nfleek help\n```\n\nTo see all available commands for a service, use the help documentation as any one of the followings:\n\n```bash\nfleek \u003cservice\u003e help\nfleek \u003cservice\u003e \u003ccommand\u003e help\n```\n\nTo get the version of the Fleek CLI:\n\n```bash\nfleek --version\n```\n\n## Contributing\n\nThis 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:\n\n1. Fork the project [here](https://github.com/fleekxyz/cli)\n2. Create your feature branch using our [branching strategy](#branching-strategy), e.g. `git checkout -b feat/my-new-feature`\n3. Run the tests: `pnpm test`\n4. Commit your changes by following our [commit conventions](#conventional-commits), e.g. `git commit -m 'chore: 🤖 my contribution description'`\n5. Push to the branch, e.g. `git push origin feat/my-new-feature`\n6. Create new Pull Request following the corresponding template guidelines\n\n### Branching strategy\n\nThe 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.\n\nFeature 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).\n\n### Conventional commits\n\nWe 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.\n\nThe commit messages are formatted as **[type]/[scope]**\nThe **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.\n\nThe **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.\n\nHere's an example of different conventional commits messages that you should follow:\n\n```txt\ntest: 💍 Adding missing tests\nfeat: 🎸 A new feature\nfix: 🐛 A bug fix\nchore: 🤖 Build process or auxiliary tool changes\ndocs: 📝 Documentation only changes\nrefactor: 💡 A code change that neither fixes a bug or adds a feature\nstyle: 💄 Markup, white-space, formatting, missing semi-colons...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffleek-platform%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffleek-platform%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffleek-platform%2Fcli/lists"}