{"id":25902283,"url":"https://github.com/dapplets/dapplets-cli","last_synced_at":"2025-08-09T23:08:48.290Z","repository":{"id":192904439,"uuid":"687508415","full_name":"dapplets/dapplets-cli","owner":"dapplets","description":"The tooling for deployment of dapplet modules to registries.","archived":false,"fork":false,"pushed_at":"2023-09-14T13:38:22.000Z","size":195,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-11T16:14:14.183Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/dapplets.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2023-09-05T13:54:46.000Z","updated_at":"2023-09-08T08:37:58.000Z","dependencies_parsed_at":"2023-09-05T21:56:53.280Z","dependency_job_id":"e84fe165-5f96-4241-b394-8e389fed8b4e","html_url":"https://github.com/dapplets/dapplets-cli","commit_stats":null,"previous_names":["dapplets/dapplets-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dapplets/dapplets-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplets-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplets-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplets-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplets-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dapplets","download_url":"https://codeload.github.com/dapplets/dapplets-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplets-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269440691,"owners_count":24417488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-08T02:00:09.200Z","response_time":72,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2025-03-03T03:15:48.376Z","updated_at":"2025-08-09T23:08:48.263Z","avatar_url":"https://github.com/dapplets.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dapplets CLI\n\nToolkit for deploying dapplet modules in registries.\n\n## Installation\n\n### Install Globally\n\n```bash\nnpm install -g @dapplets/cli\n```\n\n### Install Locally\n\n```bash\nnpm install --save-dev @dapplets/cli\n```\n\n## Usage\n\n```bash\nUsage: dapplets [options] [command]\n\nDapplets CLI utility.\n\nOptions:\n  -V, --version                   output the version number\n  -k, --eth-private-key \u003ckey\u003e     Ethereum private key (env: ETH_PRIVATE_KEY)\n  -r, --target-registry \u003curl\u003e     Target registry (env: TARGET_REGISTRY)\n  -i, --ipfs-gateway-url \u003curl\u003e    Ipfs gateway URL (env: IPFS_GATEWAY_URL)\n  -I, --ipfs                      save module to IPFS\n  -b, --module-branch             Module branch to deploy\n  -h, --help                      display help for command\n\nCommands:\n  deploy [options] [module-name]  Deploy module: FEATURE, CONFIG, and INTERFACE.\n  help [command]                  display help for command\n```\n\n```bash\nUsage: dapplets deploy [options] [module-name]\n\nDeploy module: FEATURE, CONFIG, and INTERFACE.\n\nArguments:\n  module-name                 Module name to deploy\n\nOptions:\n  -d, --dev-server-url \u003curl\u003e  Developer server URL (env: DEV_SERVER_URL)\n  -n, --module-name [name]    The name of the module to be deployed (env: MODULE_NAME)\n  -h, --help                  display help for command\n```\n\n## Examples\n\nRun `module` (`dapplet`, `adapter` or `virtual adapter`) from a project root directory containing a manifest.json file.\n\nThe following global parameters can be filled using environment variables:\n\n| Parameter                      | Environment Variable |\n| ------------------------------ | -------------------- |\n| `-k, --eth-private-key \u003ckey\u003e`  | `ETH_PRIVATE_KEY`    |\n| `-r, --target-registry \u003curl\u003e`  | `TARGET_REGISTRY`    |\n| `-i, --ipfs-gateway-url \u003curl\u003e` | `IPFS_GATEWAY_URL`   |\n| `-d, --dev-server-url \u003curl\u003e`   | `DEV_SERVER_URL`     |\n| `-n, --module-name [name]`     | `MODULE_NAME`        |\n\nExample of Windows command line:\n\n```bash\n$ set ETH_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 \u0026\u0026 set TARGET_REGISTRY=test.v3.registry.dapplet-base.eth \u0026\u0026 set IPFS_GATEWAY_URL=https://ipfs-gateway.mooo.com \u0026\u0026 set DEV_SERVER_URL=https://localhost:3000/dapplet.json \u0026\u0026 dapplets deploy test-dapplet --ipfs\n```\n\nWhen the variables have already been set:\n\n```bash\n$ dapplets deploy \u003cMODULE_NAME\u003e --ipfs\n```\n\nIf you prefer to set MODULE_NAME environment variable:\n\n```bash\n$ dapplets deploy -I\n```\n\n## CI/CD\n\nYou can use [concurrently](https://www.npmjs.com/package/concurrently) or similar tool to run the module and deploy it with a single npm script in the `package.json`:\n\n```json\n\"scripts\": {\n    \"cd\": \"concurrently -c \\\"yellow,green\\\" -n \\\"dapplet,cli\\\" \\\"npm start\\\" \\\"npx @dapplets/cli@latest deploy -I\\\" -ks \\\"command-cli\\\"\"\n  },\n```\n\nUse it in your CI/CD. The examples of GitHub Actions workflows:\n\n-   for one dapplet: https://github.com/dapplets/tipping-dapplet/blob/develop/.github/workflows/cd.yml\n-   for monorepo use a reusable workflow: https://github.com/dapplets/modules-monorepo/blob/develop/.github/workflows/cd.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapplets%2Fdapplets-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdapplets%2Fdapplets-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapplets%2Fdapplets-cli/lists"}