{"id":16841630,"url":"https://github.com/kevinpollet/seel","last_synced_at":"2025-07-19T16:09:24.191Z","repository":{"id":48332941,"uuid":"202318052","full_name":"kevinpollet/seel","owner":"kevinpollet","description":"Build container images for your Node.js applications","archived":false,"fork":false,"pushed_at":"2021-08-01T01:30:12.000Z","size":402,"stargazers_count":24,"open_issues_count":40,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-27T18:13:02.484Z","etag":null,"topics":["cli","container","container-image","containerization","docker","node","nodejs"],"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/kevinpollet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2019-08-14T09:24:16.000Z","updated_at":"2023-07-17T10:01:59.000Z","dependencies_parsed_at":"2022-09-09T01:12:33.573Z","dependency_job_id":null,"html_url":"https://github.com/kevinpollet/seel","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fseel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fseel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fseel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fseel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinpollet","download_url":"https://codeload.github.com/kevinpollet/seel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243846976,"owners_count":20357294,"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","container","container-image","containerization","docker","node","nodejs"],"created_at":"2024-10-13T12:42:32.888Z","updated_at":"2025-03-17T04:33:50.772Z","avatar_url":"https://github.com/kevinpollet.png","language":"TypeScript","readme":"# seel \u003c!-- omit in toc --\u003e\n\n[![Build Status](https://github.com/kevinpollet/seel/workflows/build/badge.svg)](https://github.com/kevinpollet/seel/actions)\n[![npm Latest Version](https://img.shields.io/npm/v/seel/latest)](https://www.npmjs.com/package/seel)\n[![npm Downloads](https://img.shields.io/npm/dm/seel)](https://www.npmjs.com/package/seel)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![License](https://img.shields.io/github/license/kevinpollet/seel)](./LICENSE.md)\n[![GitHub stars](https://img.shields.io/github/stars/kevinpollet/seel?style=social)](https://github.com/kevinpollet/seel/stargazers)\n[![Twitter Follow](https://img.shields.io/twitter/follow/kevinpollet?style=social)](https://twitter.com/kevinpollet)\n\n**seel** is a command-line tool that facilitates the build of container images for your [Node.js](https://nodejs.org/) applications. You don't need to master container best practices or write a [Dockerfile](https://docs.docker.com/engine/reference/builder/) to build a container image, it's just as simple as invoking a command from your shell or npm script.\n\n- **Simple** - No need to write a Dockerfile or master container best practices.\n- **Flexible** - Overwrite opinionated defaults to fit your needs.\n- **Fast** - Optimized image layers to take advantage of build caching.\n\n![screencast](https://cdn.jsdelivr.net/gh/kevinpollet/seel@be83df272ac6ca4f19455093f46013dba7541530/screencast.svg)\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e (click to expand)\u003c/summary\u003e\n\n- [Install](#install)\n- [Usage](#usage)\n  - [CLI](#cli)\n  - [API](#api)\n- [Examples](#examples)\n- [Contributing](#contributing)\n- [Contributors](#contributors)\n- [License](#license)\n\n\u003c/details\u003e\n\n## Install\n\n**npm**\n\n```shell\nnpx seel                      # Run it once.\nnpm install --global seel     # Install globally.\nnpm install --save-dev seel   # Install locally to use it in npm scripts.\n```\n\n**Yarn**\n\n```shell\nyarn global add seel          # Install globally.\nyarn add seel --dev           # Install locally to use it in npm scripts.\n```\n\n## Usage\n\n\u003e **Note: seel uses the [Docker daemon](https://docs.docker.com/engine/docker-overview/) to build the container image. When you invoke the seel command, the daemon must be running and accessible through the `/var/run/docker.sock` socket.**\n\n### CLI\n\n#### Options \u003c!-- omit in toc --\u003e\n\n| Name                      | Description                                                                                                                                                                                                                                                            |\n| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ‑v, ‑‑version             | Print version.                                                                                                                                                                                                                                                         |\n| ‑h, ‑‑help                | Print usage information.                                                                                                                                                                                                                                               |\n| ‑‑cwd                     | Define the current working directory, defaults to `.`.                                                                                                                                                                                                                 |\n| ‑‑entrypoint              | Define the app entrypoint, defaults to `bin` or `main` script defined in `package.json`. The given `path` must be relative to the cwd.                                                                                                                                 |\n| ‑‑extra‑files             | Define the extra files to include in the container image with a glob pattern, e.g. `--extra-files 'public/**'`.                                                                                                                                                        |\n| ‑‑label                   | Define the container image label, e.g. `--label key=value --label key2=value2`. By default, the `version`, `description` and `maintainer` labels are added to the container image.                                                                                     |\n| ‑‑name                    | Define the container image name, defaults to the app `name` defined in `package.json`.                                                                                                                                                                                 |\n| ‑‑pkg‑registry‑auth‑url   | Set-up authentication for the given package registry base URL, e.g. `https://myregistry.example.com`. If the authentication token is not defined with `‑‑pkg‑registry‑auth‑token` the environment variable `AUTH_TOKEN` will be used to read the authentication token. |\n| ‑‑pkg‑registry‑auth‑token | Define the authentication token for the package registry base URL previously configured.                                                                                                                                                                               |\n| ‑‑port                    | Define the port that the container exposes at runtime, e.g. `--port 3000 --port 4000/udp`.                                                                                                                                                                             |\n| ‑‑tag                     | Define the container image tag, e.g. `--tag latest --tag 1.0.0`. By default, the [Semantic Versioning](https://semver.org/) strategy is used to define the container image tags.                                                                                       |\n\n### API\n\n```typescript\nimport { buildImage, BuildImageOptions } from \"seel\";\n\nconst options: BuildImageOptions = {\n  entrypoint?: string;\n  extraFiles?: string[];\n  name?: string;\n  ports?: string[];\n  tags?: string[];\n  labels?: {\n    [key: string]: string\n  };\n  pkgRegistryAuth?: {\n    url: string;\n    token: string\n  };\n};\n\nbuildImage(\"/usr/app\", options)\n  .then(stream =\u003e stream\n    .once(\"error\", () =\u003e {\n      console.log(err);\n      process.exit(1);\n    })\n    .pipe(process.stdout)\n  )\n  .catch(err =\u003e {\n    console.log(err);\n    process.exit(2);\n  });\n```\n\n## Examples\n\nThe [examples](./examples) directory contains the following examples:\n\n- [NestJS application](./examples/nestjs)\n- [Express application](./examples/express)\n- [Command-line application](./examples/cli)\n- [Command-line application with ECMAScript Modules](./examples/cli-esm)\n\n## Contributing\n\nContributions are welcome!\n\nWant to file a bug, request a feature or contribute some code?\n\nCheck out the [contribution guidelines](./CONTRIBUTING.md).\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://kevinpollet.dev\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/299142?v=4\" width=\"100px;\" alt=\"Kevin Pollet\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKevin Pollet\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kevinpollet/seel/commits?author=kevinpollet\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/kevinpollet/seel/commits?author=kevinpollet\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#infra-kevinpollet\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## License\n\n[MIT](./LICENSE.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinpollet%2Fseel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinpollet%2Fseel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinpollet%2Fseel/lists"}