{"id":24860872,"url":"https://github.com/ajaysinghnp/node-helper","last_synced_at":"2025-03-26T16:25:48.183Z","repository":{"id":196184952,"uuid":"694590335","full_name":"ajaysinghnp/node-helper","owner":"ajaysinghnp","description":"This is the utility module for node js to generate .sample.env file for the projects.","archived":false,"fork":false,"pushed_at":"2023-09-26T17:21:09.000Z","size":1728,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-13T15:17:19.787Z","etag":null,"topics":["dot-env","env","generator","sample-env"],"latest_commit_sha":null,"homepage":"https://mentormaya.github.io/node-helper","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/ajaysinghnp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-09-21T09:53:59.000Z","updated_at":"2023-09-25T10:25:54.000Z","dependencies_parsed_at":"2023-09-22T16:04:31.905Z","dependency_job_id":"7e93ead5-1439-4c74-89b2-ab7e2821a0a9","html_url":"https://github.com/ajaysinghnp/node-helper","commit_stats":null,"previous_names":["mentormaya/env-helper","ajaysinghnp/node-helper","mentormaya/node-helper"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaysinghnp%2Fnode-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaysinghnp%2Fnode-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaysinghnp%2Fnode-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaysinghnp%2Fnode-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajaysinghnp","download_url":"https://codeload.github.com/ajaysinghnp/node-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245690986,"owners_count":20656687,"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":["dot-env","env","generator","sample-env"],"created_at":"2025-01-31T21:48:30.825Z","updated_at":"2025-03-26T16:25:48.160Z","avatar_url":"https://github.com/ajaysinghnp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NODE HELPER\n\nThis is the `helper` utility tool for the projects for developer. This tool is aimed to help `developers` 🧑‍💻 with many small things like setup, generate boilerplate code, generating sample.env file and many more.\n\n**NODE HELPER** helps with ....\n\n- [x] sample.env file generator 🗂️\n- [ ] boilerplate code generator 🗂\n  - [ ] Static Website 🌍\n  - [ ] Next.js 🌍\n  - [ ] React App 🌍\n- [ ] init ESLint 🖥️\n- [ ] init test with jest 🧪\n\n## Installation\n\nIt can be install with below command using npm\n\n```bash\nnpm i -D @mentormaya/helper\n```\n\nIt can be install with below command using yarn\n\n```bash\nyard add -D @mentormaya/helper\n```\n\nIt can be install with below command using pnpm\n\n```bash\npnpm add -D @mentormaya/helper\n```\n\n## Basic Syntax\n\n```bash\nUsage: helper [options] [command]\n```\n\nwhere options are:\n\n```bash\nOptions:\n  -V, --version      output the version number\n  -h, --help         display help for command\n```\n\nand commands are:\n\n```bash\nCommands:\n  gen-env [options]  Generate Sample ENV(.env.sample) from .env file.\n  help [command]     display help for command\n```\n\n## Usage\n\nsimply run the following command in the terminal of your choice.\n\n\u003eNote: This is the Node CLI tool, thats why you need to have nodejs pre installed in your operating system for this tool to work.\n\n```bash\nhelper\n```\n\nwill show about the app and usage.\n\n![basic usage of helper](/images/helper.png \"helper command preview\")\n\n### for help\n\n```bash\nhelper --help\n```\n\nwill show the help for the `helper`:\n\n![help with options](/images/help-option.png \"help option preview\")\n\nor\n\n```bash\nhelp [command]\n```\n\nwill show the help for the `helper` or for the selected command if command provided:\n\n![help with options](/images/help-command.png \"help option preview\")\n\nAlso we can know about the version information of the command with\n\n```bash\nhelp -V\n```\n\nor\n\n```bash\nhelp --version\n```\n\nwill show the version for the `helper`:\n\n![help with options](/images/version.png \"help option preview\")\n\n### for generating a sample.env from project .env file\n\n\u003eWarning: Be aware that this command will replace you existing .env.sample or any name for sample you provided if already exist in the root of your project.\n\n```bash\nhelper gen-env\n```\n\nThis will prompt you for the values required to generate the sample.env file such as your .env file name, your sample.env filename, the value template etc.\n\n![sample env generator](/images/gen-env.png \"gen-env preview\")\n\nAlso you can generate the output to only the screen and not actually write it to file.\n\n```bash\nhelper gen-env -d\n```\n\nor \n\n```bash\nhelper gen-env --dry-run\n```\n\nor simply select `true` or say `Yes` while prompting if you use\n\n```bash\nhelper gen-env\n```\n\n![sample env generator](/images/gen-env-console.png \"gen-env preview\")\n\nThis way you can verify the content before writting it to the file.\n\nGreat 🥳\n\nLot's of noise right 👉\n\nLet's do it silently without any interaction. Incase you have to include it in the `precommit` of your git repository to automatically generate sample.nv file each time you make a commit.\n\n```bash\nhelper gen-env -s\n```\n\nor \n\n```bash\nhelper gen-env --silent\n```\n\nThis will do the job silently with default values and ofcourse, you can supply your own values with the options as below:\n\n```bash\nhelper gen-env -s -n .my-env -N .sample-env\n```\n\nor\n\n```bash\nhelper gen-env --silent --name .my-env --sample .sample-env\n```\n\nYahoooo!!!! 🎉🎉🎉\n\nLet's Rock and Roll now without any tension to forget to update the sample.env file anymore.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajaysinghnp%2Fnode-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajaysinghnp%2Fnode-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajaysinghnp%2Fnode-helper/lists"}