{"id":50674204,"url":"https://github.com/deploykithq/deploykit-cli","last_synced_at":"2026-06-08T14:33:12.291Z","repository":{"id":355664347,"uuid":"1229161983","full_name":"deploykithq/deploykit-cli","owner":"deploykithq","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-04T19:07:14.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-05-04T19:08:34.860Z","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/deploykithq.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-04T19:05:23.000Z","updated_at":"2026-05-04T19:07:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/deploykithq/deploykit-cli","commit_stats":null,"previous_names":["deploykithq/deploykit-cli"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/deploykithq/deploykit-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deploykithq%2Fdeploykit-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deploykithq%2Fdeploykit-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deploykithq%2Fdeploykit-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deploykithq%2Fdeploykit-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deploykithq","download_url":"https://codeload.github.com/deploykithq/deploykit-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deploykithq%2Fdeploykit-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34067350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"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":"2026-06-08T14:33:11.257Z","updated_at":"2026-06-08T14:33:12.284Z","avatar_url":"https://github.com/deploykithq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @deploykit/cli\n\n\u003e Install, update, and manage a self-hosted [DeployKit](https://github.com/deploykithq/deploykit) instance on a Linux VPS.\n\n```bash\nnpm install -g @deploykit/cli\nsudo deploykit install --domain deploy.example.com --email you@example.com\n```\n\nThis is a native Node port of the `curl | sh` installer that ships with DeployKit. Everything the shell installer does — installing Docker, cloning the repo, generating secrets, building containers, bootstrapping the admin account — is reproduced here as a typed, scriptable CLI.\n\n---\n\n## Requirements\n\n- A Linux VPS (Ubuntu, Debian, RHEL, Alpine)\n- Root or `sudo`\n- Node.js \u003e= 20 on the VPS (only needed to run the CLI itself; everything else is installed for you)\n- Ports 80 and 443 reachable from the public internet\n\n\u003e The CLI refuses to run on macOS or Windows on purpose. Connect to the VPS via SSH and run it there.\n\n## Install the CLI\n\n```bash\nnpm install -g @deploykit/cli\n```\n\nOr one-shot via `npx`:\n\n```bash\nsudo npx @deploykit/cli install --domain deploy.example.com --email you@example.com\n```\n\n## Commands\n\n### `deploykit install`\n\nBootstraps DeployKit on the current machine.\n\n```bash\nsudo deploykit install \\\n  --domain deploy.example.com \\\n  --email you@example.com \\\n  --admin-email admin@example.com \\\n  --admin-password mypassword123\n```\n\n| Flag | Description | Default |\n|------|-------------|---------|\n| `--domain \u003cdomain\u003e` | Dashboard domain (required) | — |\n| `--email \u003cemail\u003e` | Let's Encrypt email (required) | — |\n| `--admin-email \u003cemail\u003e` | Pre-create admin account | — |\n| `--admin-password \u003cpwd\u003e` | Admin password, min 8 chars | — |\n| `--dir \u003cpath\u003e` | Install directory | `/opt/deploykit` |\n| `--branch \u003cbranch\u003e` | Git branch to install | `master` |\n\nIf `--domain` and `--email` are omitted in a TTY, the CLI drops into interactive prompts.\n\n### `deploykit update`\n\nPulls the latest commit, rebuilds the images, and restarts the stack.\n\n```bash\nsudo deploykit update\n```\n\n### `deploykit status`\n\nLists running containers via `docker compose ps`.\n\n```bash\ndeploykit status\n```\n\n### `deploykit logs`\n\nStreams live logs from all services.\n\n```bash\ndeploykit logs\n```\n\n### `deploykit restart`\n\nRestarts every DeployKit service.\n\n```bash\nsudo deploykit restart\n```\n\n### `deploykit uninstall`\n\nStops the stack and removes the installation. Add `--delete-data` to wipe Postgres/Redis volumes and backups.\n\n```bash\nsudo deploykit uninstall --yes\nsudo deploykit uninstall --yes --delete-data\n```\n\n## After install\n\n```text\nDashboard:  https://\u003cyour-domain\u003e\nDirectory:  /opt/deploykit\n```\n\nMake sure an `A` record points your domain to the server's public IP — Traefik issues a Let's Encrypt cert on first request.\n\n## Development\n\n```bash\ngit clone https://github.com/deploykithq/deploykit-cli.git\ncd deploykit-cli\nnpm install\nnpm run dev -- install --help    # run from source\nnpm run build                    # compile to dist/\nnpm run lint                     # tsc --noEmit\n```\n\nThe CLI itself is pure Node (no shell scripts) so you can lint and build it from any OS, but the runtime ops (Docker, systemctl, apt-get) only succeed on Linux.\n\n## Publishing\n\n```bash\nnpm login\nnpm version patch    # or minor / major\nnpm publish --access public\n```\n\n`prepublishOnly` runs `clean \u0026\u0026 build`. The published tarball only includes `dist/`, `README.md`, and `LICENSE`.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeploykithq%2Fdeploykit-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeploykithq%2Fdeploykit-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeploykithq%2Fdeploykit-cli/lists"}