{"id":44974186,"url":"https://github.com/fleek-platform/sdk","last_synced_at":"2026-02-18T16:30:35.342Z","repository":{"id":260721825,"uuid":"860536146","full_name":"fleek-platform/sdk","owner":"fleek-platform","description":"The Fleek-Platform SDK provides an unified interface to help you quickly build applications that leverage our Fleek Services.","archived":false,"fork":false,"pushed_at":"2025-05-14T00:28:13.000Z","size":1618,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-05-14T02:26:48.716Z","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":null,"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":null,"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}},"created_at":"2024-09-20T16:10:21.000Z","updated_at":"2025-02-25T10:28:59.000Z","dependencies_parsed_at":"2024-11-02T04:24:16.071Z","dependency_job_id":"5d1fd6b7-fee7-4ef2-a68f-a987caa929eb","html_url":"https://github.com/fleek-platform/sdk","commit_stats":null,"previous_names":["fleek-platform/sdk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fleek-platform/sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fleek-platform","download_url":"https://codeload.github.com/fleek-platform/sdk/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fleek-platform%2Fsdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29585531,"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:32.167Z","updated_at":"2026-02-18T16:30:35.334Z","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 SDK\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\nThe Fleek Platform SDK provides an unified interface to help you quickly build applications that leverage our Fleek Services.\n\nIt's distributed as an ESM module for Web browsers, or CJS module for NodeJs Server applications. The server version provides a wider range of features, as some features are dependent of Native NodeJs modules.\n\nTo learn more about it read our documentation available [here](https://fleek.xyz/docs).\n\n## Overview\n\n* [🤖 Install](#install)\n* [👷‍♀️Development](#development)\n  - [Code format](#code-format)\n  - [Changeset](#changeset)\n* [🧸 Basic Usage](#basic-usage)\n* [📖 Docs](https://fleek.xyz/docs/sdk)\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 SDK, or PNPM for development\n- Familiarity with Nodejs, Frontend/Client side development\n\n## Install\n\nInstall the package by executing:\n\n```sh\nnpm i @fleek-platform/sdk\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 usage](#basic-usage), or alternatively visit our [documentation](https://fleek.xyz/docs/sdk)\n\n## Development\n\nFor developers looking to contribute to the `@fleek-platform/sdk`, [clone](https://github.com/fleekxyz/sdk) 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\nSDK__AUTH_APPS_URL=\"https://auth-apps.service.fleek.xyz\"\nSDK__IPFS__STORAGE_API_URL=\"https://storage-ipfs.service.fleek.xyz\"\nSDK__GRAPHQL_API_URL=\"https://graphql.service.fleek.xyz/graphql\"\nSDK__UPLOAD_PROXY_API_URL=\"https://uploads.service.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\nLearn the Fleek-platform SDK basic usage [here](#basic-usage). For extended documentation visit our [documentation site](https://fleek.xyz/docs/sdk).\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 usage\n\nThe following provides a basic example of how to import the web browser or node SDK versions into your project and run a few simple commands.\n\nFor a complete description, read our documentation [here](https://fleek.xyz/docs/sdk).\n\n### Browser\n\nThe browser version is meant for applications that should run in a web browser and do not require NodeJs native modules.\n\nStart by importing the web version from our SDK.\n\n```ts\nimport { FleekSdk } from '@fleek-platform/sdk/browser';\nconst sdk = new FleekSdk({\n  personalAccessToken: '\u003cPERSONAL_ACCESS_TOKEN\u003e',\n});\n```\n\nAlternatively, omit the `/browser` path, as it'll default to the web version due to retroactive support. Although, it's recommended to specify the desired target for clarity.\n\n```ts\nimport { FleekSdk }from '@fleek-platform/sdk';\n```\n\n💡The `\u003cPERSONAL_ACCESS_TOKEN\u003e` can be obtained by utilizing the `@fleek-platform/cli`, learn more about it [here](https://fleek.xyz/docs/cli).\n\n### NodeJs\n\nFor NodeJs projects import the distribution under the path `@fleek-platform/sdk/node`. This is a commonjs distribution (CJS), suitable for NodeJs environments. The Nodejs version has a wider feature support due to some features requiring features such as the file system, etc.\n\nUse the following import statement:\n\n```ts\nimport { FleekSdk } from '@fleek-platform/sdk/node';\n```\n\nIf you don't specify the `/node` path, it'll import the client version (web), that has a narrower feature set.\n\nHere's an example where we import the `FleekSdk`, the `PersonalAccessTokenService` and get the applications list.\n\n```ts\nimport { FleekSdk, PersonalAccessTokenService } from '@fleek-platform/sdk/node';\n\nconst personalAccessToken = '\u003cPERSONAL_ACCESS_TOKEN\u003e';\nconst projectId = '\u003cFLEEK_PROJECT_ID\u003e';\n\nconst accessTokenService = new PersonalAccessTokenService({\n    personalAccessToken,\n    projectId,\n});\n\nconst fleekSdk = new FleekSdk({\n  accessTokenService,\n});\n\n(async () =\u003e {\n  const res = await fleekSdk.applications().list();\n  console.log(res);\n})();\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%2Fsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffleek-platform%2Fsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffleek-platform%2Fsdk/lists"}