{"id":15819552,"url":"https://github.com/florianrappl/piral-cli-dotenv","last_synced_at":"2026-01-11T01:34:46.324Z","repository":{"id":53324393,"uuid":"237375281","full_name":"FlorianRappl/piral-cli-dotenv","owner":"FlorianRappl","description":"Adds a flag to include environment variables from .env files. :rocket:","archived":false,"fork":false,"pushed_at":"2024-04-15T08:36:09.000Z","size":375,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-06T06:41:35.505Z","etag":null,"topics":["cli","dotenv","environment-variables","microfrontend","piral","plugin"],"latest_commit_sha":null,"homepage":"https://piral.io","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/FlorianRappl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["FlorianRappl"],"custom":["https://www.paypal.me/FlorianRappl"]}},"created_at":"2020-01-31T06:42:57.000Z","updated_at":"2024-04-15T08:32:17.000Z","dependencies_parsed_at":"2024-06-21T20:24:41.680Z","dependency_job_id":"f65e9940-e336-49a5-ad83-486124f319b9","html_url":"https://github.com/FlorianRappl/piral-cli-dotenv","commit_stats":{"total_commits":8,"total_committers":3,"mean_commits":"2.6666666666666665","dds":0.625,"last_synced_commit":"6bf4acac8100a4bd1cf92f2c74590fef17adccf0"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlorianRappl%2Fpiral-cli-dotenv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlorianRappl%2Fpiral-cli-dotenv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlorianRappl%2Fpiral-cli-dotenv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlorianRappl%2Fpiral-cli-dotenv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlorianRappl","download_url":"https://codeload.github.com/FlorianRappl/piral-cli-dotenv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246591782,"owners_count":20801986,"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","dotenv","environment-variables","microfrontend","piral","plugin"],"created_at":"2024-10-05T06:41:41.746Z","updated_at":"2026-01-11T01:34:46.309Z","avatar_url":"https://github.com/FlorianRappl.png","language":"TypeScript","funding_links":["https://github.com/sponsors/FlorianRappl","https://www.paypal.me/FlorianRappl"],"categories":[],"sub_categories":[],"readme":"# piral-cli-dotenv\n\n![Azure Build Status](https://dev.azure.com/FlorianRappl/piral-cli-plugins/_apis/build/status/FlorianRappl.piral-cli-dotenv?branchName=main) ![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)\n\nPlugin for the `piral-cli`. Adds a flag to include environment variables from *.env* files.\n\nExtends the Piral CLI command options to include dotenv files.\n\n## Installation\n\nInstall the plugin either locally or globally.\n\nWe recommend the local installation:\n\n```sh\nnpm i piral-cli-dotenv --save-dev\n```\n\n## Usage\n\n### Including a .env File\n\nSome commands of the Piral CLI will be extended with `--env` flags, e.g.,\n\n```sh\npiral debug \u003cregular options\u003e --env\n```\n\nThe list of supported / extended commands is:\n\n- `build-piral`\n- `debug-piral`\n- `validate-piral`\n- `build-pilet`\n- `debug-pilet`\n- `publish-pilet`\n- `validate-pilet`\n\nThe `--env` flags behave as follows.\n\n#### No argument\n\nStandard dotenv resolution mechanism, e.g., takes a `.env` file if available.\n\nExample Call:\n\n```sh\npiral build \u003cregular options\u003e --env\n```\n\n#### File path\n\nUses the path to resolve and use the file as dotenv input.\n\nExample input:\n\n```plain\n./secrets/.env\n```\n\nExample call:\n\n```sh\npiral build \u003cregular options\u003e --env .env.prod\n```\n\n#### Name\n\nUses a file `{name}.env` or `.env.{name}` as input for dotenv.\n\nExample input:\n\n```plain\nprod\n```\n\nExample call:\n\n```sh\npiral build \u003cregular options\u003e --env prod\n```\n\n#### Variables\n\nUses the provided values as environment variables.\n\nExample inputs:\n\n```plain\nFOO=BAR\nFOO=\"BAR\";BAR=\"FOO\"\n```\n\nExample call:\n\n```sh\npiral build \u003cregular options\u003e --env SERVICE_URL=\"http://example.com\"\n```\n\n## FAQ\n\n### Does it work with every bundler?\n\nYes.\n\n### Are some environment variables overwritten?\n\nYes. Some variables are special (e.g., `NODE_ENV`) and will be set by the `piral-cli` anyway. This plugin focuses on non-special variables.\n\n## License\n\nThis plugin is released using the MIT license. For more information see the [LICENSE file](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflorianrappl%2Fpiral-cli-dotenv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflorianrappl%2Fpiral-cli-dotenv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflorianrappl%2Fpiral-cli-dotenv/lists"}