{"id":25902375,"url":"https://github.com/dapplets/dapplet-cli","last_synced_at":"2026-06-06T04:31:53.095Z","repository":{"id":39873423,"uuid":"200009805","full_name":"dapplets/dapplet-cli","owner":"dapplets","description":"The tooling for deployment of dapplet modules to registries.","archived":false,"fork":false,"pushed_at":"2022-06-25T06:54:04.000Z","size":93,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-15T13:44:12.862Z","etag":null,"topics":["cli","dapplets"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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}},"created_at":"2019-08-01T08:27:09.000Z","updated_at":"2023-02-13T18:30:23.000Z","dependencies_parsed_at":"2022-08-26T03:00:49.990Z","dependency_job_id":null,"html_url":"https://github.com/dapplets/dapplet-cli","commit_stats":null,"previous_names":["dapplets/dapplet-deployer"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplet-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplet-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplet-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapplets%2Fdapplet-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dapplets","download_url":"https://codeload.github.com/dapplets/dapplet-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241600479,"owners_count":19988715,"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","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":["cli","dapplets"],"created_at":"2025-03-03T03:15:58.677Z","updated_at":"2025-03-03T03:15:59.370Z","avatar_url":"https://github.com/dapplets.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dapplets CLI\nThe tooling for deployment of dapplet modules to registries.\n\n## Installation\n### Install Globally\n```\nnpm install -g @dapplets/cli\n```\n### Install Locally\n```\nnpm install --save-dev @dapplets/cli\n```\n\n## Usage\n```\nUsage: dapplet [options] [command]\n\nOptions:\n  -V, --version            output the version number\n  -r, --registry [address] set the registry endpoint address. default: https://test.dapplets.org\n  -a, --account \u003caccount\u003e  set the account name\n  -k, --key \u003ckey\u003e          set the account key\n  -h, --help               output usage information\n\nCommands:\n  create                   create new module\n  deploy                   run deploy of module to registry\n  add-site \u003chostname\u003e      add site-binding\n```\n\n```\nUsage: deploy [options]\n\nrun deploy of module to registry\n\nOptions:\n  -A, --archive  publish archive modules from \"archive\" folder\n  -h, --help     output usage information\n```\n\n## Examples\nRun `dapplet` 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| `-r, --registry` | `DAPPLET_CLI_REGISTRY` |\n| `-a, --account` | `DAPPLET_CLI_ACCOUNT` |\n| `-k, --key` | `DAPPLET_CLI_KEY` |\n\nExample of Windows command line:\n```\n$ set DAPPLET_CLI_REGISTRY=https://test.dapplets.org \u0026\u0026 set DAPPLET_CLI_ACCOUNT=test \u0026\u0026 set DAPPLET_CLI_KEY=testkey \u0026\u0026 dapplet deploy\n```\n\n### Generate new module\n```\n$ dapplet create\n```\n\n1. Answer the questions. \n2. After creating a project change dir to a created directory and run `npm start` to build and run watching.\n3. Add dependencies (e.g. adapters), which you will use in your code via `@Inject()` decorators, into `manifest.json` file:\n```json\n\"dependencies\": {\n  // branch - default\n  \"twitter-adapter.dapplet-base.eth\": \"0.3.5\",\n  // specific branch\n  \"twitter-adapter.dapplet-base.eth\": {\n    \"default\": \"0.3.5\",\n    \"legacy\": \"0.3.5\",\n    \"new\": \"0.3.5\"\n  }\n}\n```\n4. Add URL to the Developer tab of the Extension: `http://localhost:10001/dapplets.json`\n5. Turn on your Feature in the Features tab and refresh context page.\n\n### Deploy package to registry\n```\n$ dapplet -a test -k testkey deploy\n```\n\n### Deploy package with archive modules to registry **[WILL BE DEPRECATED]**\n```\n$ dapplet -a test -k testkey deploy --archive\n```\n\nArchive modules will be loaded from `archive` subfolder of root project folder. An `archive` directory must contain folders with the version name containing a manifest and module script. \n\nExample of `archive` directory structure:\n```\n$/\n  0.1.0/\n    index.js\n    manifest.json\n  0.1.1/\n    index.js\n    manifest.json\n```\n\n### Add site-binding\n```\n$ dapplet -a test -k testkey add-site example.com\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapplets%2Fdapplet-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdapplets%2Fdapplet-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapplets%2Fdapplet-cli/lists"}