{"id":26893562,"url":"https://github.com/dazz/s6-cli","last_synced_at":"2025-07-06T00:02:58.369Z","repository":{"id":215448117,"uuid":"738492924","full_name":"dazz/s6-cli","owner":"dazz","description":"This cli tool can be used to help you setup your projects s6-overlay files and directories","archived":false,"fork":false,"pushed_at":"2024-01-17T14:40:14.000Z","size":58,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-29T08:36:00.650Z","etag":null,"topics":["ci","docker","lint","s6","s6-overlay"],"latest_commit_sha":null,"homepage":"","language":"Go","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/dazz.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":"2024-01-03T10:58:15.000Z","updated_at":"2025-06-09T08:07:58.000Z","dependencies_parsed_at":"2024-06-21T20:27:03.090Z","dependency_job_id":"abe30632-1a40-4d05-8c2a-d74d85df2203","html_url":"https://github.com/dazz/s6-cli","commit_stats":null,"previous_names":["dazz/s6-cli"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/dazz/s6-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dazz%2Fs6-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dazz%2Fs6-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dazz%2Fs6-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dazz%2Fs6-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dazz","download_url":"https://codeload.github.com/dazz/s6-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dazz%2Fs6-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263826611,"owners_count":23516780,"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":["ci","docker","lint","s6","s6-overlay"],"created_at":"2025-03-31T23:58:22.400Z","updated_at":"2025-07-06T00:02:58.345Z","avatar_url":"https://github.com/dazz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# s6-cli: CLI for s6-overlay\nThis cli tool can be used to help you setup your projects s6-overlay files and directories. It can also be used to create, remove and lint services.\n\n## s6-overlay\n\u003e s6-overlay is an easy-to-install (just extract a tarball or two!) set of scripts and utilities allowing you to use existing Docker images while using s6 as a pid 1 for your container and process supervisor for your services.\nTo know more about s6-overlay visit [github.com/just-containers/s6-overlay](https://github.com/just-containers/s6-overlay).\n\n\n## Setup\n\n```bash\ngit clone git@github.com:dazz/s6-cli.git\ncd s6-cli\nmake help\n```\n\nThere is a Makefile that you can use to execute helpful commands. Following is a small list for some more important targets.\nRun `make` or `make help` to see all possible targets.\n\n## Build\n There are a few options here how you can install the executable on the target system.\n\n### Go\nBuilds the executable and places it in the current directory\n```bash\nmake build\n```\n\n### Nix shell\nIf you have nix-shell you can run the following command to get a shell with the cli installed\n```bash\nmake nix\n```\n\n### Docker\nCreates a docker image with the cli installed\n```bash\nmake docker\n```\n\nor if you pulled the image from dockerhub\n```bash\ndocker run -it --rm -v ./examples/s6-overlay:/etc/s6-overlay hakindazz/s6-cli:latest\n```\n\n\n### In Dockerfile\nIf you want to use the cli in a Dockerfile you can copy it from the docker image\n```dockerfile\nCOPY --from=hakindazz/s6-cli:latest /app/s6-cli /usr/local/bin/s6-cli\n```\n\n## Usage\n\nThere is a help command that you can use to get more info about the commands in the cli. Run it with\n```bash\n./s6-cli help\n```\n### The option `--root-path {path}, -p {path}` \nAll commands need the `root-path` to be specified. It must point to the directory where services will be defined. \nDefault is set to `/etc/s6-overlay/s6-rc.d`\n\n### Create\nThere are three types of services that can be created: Oneshot, Longrun and Bundle.\nRead more about them [here](https://skarnet.org/software/s6-rc/s6-rc-compile.html)\n\n```bash\n./s6-cli  --root-path {path} create {oneshot|longrun|bundle} {service}\n```\n\n### Remove\nIf the service is not needed anymore it can be removed with the following command.\n\n```bash\n./s6-cli remove {service}\n```\n\n### Lint\n\n```bash\n./s6-cli lint\n```\n\n\n### Mermaid\nThis command will generate a mermaid graph of the services.\n\n```bash\n./s6-cli mermaid \u003e mermaid.md\n```\n\nOr pipe it directly to a markdown file\n```bash\n./s6-cli mermaid \u003e mermaid.md\n```\n\nThe output will look something like this:\n```bash\n```mermaid\ngraph TD;\n    user --\u003e prepare-directory\n    user --\u003e nginx\n    nginx --\u003e php-fpm\n    php-fpm --\u003e create-directories\n```\n\nwhich will be rendered to this:\n\n```mermaid\ngraph TD;\n    user --\u003e prepare-directory\n    user --\u003e nginx\n    nginx --\u003e php-fpm\n    php-fpm --\u003e create-directories\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdazz%2Fs6-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdazz%2Fs6-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdazz%2Fs6-cli/lists"}