{"id":28969960,"url":"https://github.com/knfs-library/bamimi-cli","last_synced_at":"2025-06-24T10:12:30.165Z","repository":{"id":250934380,"uuid":"835932017","full_name":"knfs-library/bamimi-cli","owner":"knfs-library","description":"Cli for BAMIMI Framework","archived":false,"fork":false,"pushed_at":"2025-06-13T17:49:22.000Z","size":248,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"1.x.x","last_synced_at":"2025-06-13T17:56:51.682Z","etag":null,"topics":["cli","nodejs","nodejs-cli","nodejs-framework","nodejs-frameworks","nodejs-server"],"latest_commit_sha":null,"homepage":"https://bamimi.github.io","language":"JavaScript","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/knfs-library.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-30T20:15:04.000Z","updated_at":"2025-06-13T17:49:26.000Z","dependencies_parsed_at":"2024-09-12T00:05:49.243Z","dependency_job_id":"3017f1b7-b396-4d8e-a7ed-a56bee605516","html_url":"https://github.com/knfs-library/bamimi-cli","commit_stats":null,"previous_names":["knfs-library/bamimi-cli"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/knfs-library/bamimi-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knfs-library%2Fbamimi-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knfs-library%2Fbamimi-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knfs-library%2Fbamimi-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knfs-library%2Fbamimi-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/knfs-library","download_url":"https://codeload.github.com/knfs-library/bamimi-cli/tar.gz/refs/heads/1.x.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knfs-library%2Fbamimi-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261649879,"owners_count":23189759,"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","nodejs","nodejs-cli","nodejs-framework","nodejs-frameworks","nodejs-server"],"created_at":"2025-06-24T10:12:26.204Z","updated_at":"2025-06-24T10:12:30.150Z","avatar_url":"https://github.com/knfs-library.png","language":"JavaScript","readme":"\n\u003cp align=\"center\"\u003e\n  \u003cbr\u003e\n\t\u003ca href=\"https://github.com/knfs-library/bamimi-cli/actions\" alt=\"github\"\u003e\n\t\u003cimg src=\"https://github.com/knfs-library/bamimi-cli/actions/workflows/test.yml/badge.svg\" alt=\"Github Actions\" /\u003e\n\t\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1\u003e \u003cspan style=\"color:#013C4D;\"\u003eAbout\u003c/span\u003e \u003cspan style=\"color:#2B7F84;\"\u003eBamimi CLI\u003c/span\u003e\u003c/h1\u003e\n\nBamimi CLI is a command-line tool designed to streamline the creation of common elements for your Node.js projects, including controllers, middleware, responses, requests, emails, and jobs. This tool supports rapid development and automates the creation of essential files for your project.\n\n## Install\n\nInstall this CLI tool globally using npm:\n\n```bash\nnpm install -g @knfs-tech/bamimi-cli\n```\n\nOr with yarn:\n\n```bash\nyarn global add @knfs-tech/bamimi-cli\n```\n\n## Usage\n\nYou can use this CLI tool with the following commands:\n\n### Create Project\n\n```bash\nbamimi-cli app:generate \u003cprojectName\u003e [options]\n```\n\n- `projectName`: The name of the project you want to create.\n- `-d, --description \u003cdescription\u003e`: The description of the project.\n- `-v, --version \u003cversion\u003e`: The version of the project.\n- `-dk, --docker \u003cdocker\u003e`: Use Docker (y/n).\n- `-esl, --eslint \u003ceslint\u003e`: Use Eslint (y/n).\n- `-t, --test \u003ctest\u003e`: Use Test (y/n).\n- `-dbt, --databaseType \u003cdatabaseType`: Database type(SQL, NoSQL, none).\n- `-dbc, --databaseConnection \u003cdatabaseConnection\u003e`: 'Database connection (postgres, mysql, mariadb, sqlite, mssql, snowflake, oracle, mongodb).\n- `-dbh, --databaseHost \u003cdatabaseHost\u003e`: Database host.\n- `-dbp, --databasePort \u003cdatabasePort\u003e`: Database port.\n- `-dbn, --databaseName \u003cdatabaseName\u003e`: 'Database name.\n- `-dbu, --databaseUser \u003cdatabaseUser\u003e`: Database username.\n- `-dbps, --databasePassword \u003cdatabasePassword\u003e`: Database password.\n- `-pkm, --packageManager \u003cpackageManager\u003e`: Package manager (npm, yarn, pnpm, none).\n\n### Generate Controller\n\n```bash\nbamimi-cli controller:generate \u003ccontrollerName\u003e [options]\n```\n\n- `controllerName`: The name of the controller you want to create.\n- `-p, --path \u003cpath\u003e`: Path for the controller (if you don’t want to use the default path).\n- `-f, --func \u003cfunctions...\u003e`: List of functions to create (comma-separated).\n- `-t, --type \u003ctype\u003e`: Type of controller (api or web).\n****\n### Generate Middleware\n\n```bash\nbamimi-cli middleware:generate \u003cmiddlewareName\u003e [options]\n```\n\n- `middlewareName`: The name of the middleware you want to create.\n- `-p, --path \u003cpath\u003e`: Path for the middleware (if you don’t want to use the default path).\n\n### Generate Response\n\n```bash\nbamimi-cli response:generate \u003cresponseName\u003e [options]\n```\n\n- `responseName`: The name of the response you want to create.\n- `-p, --path \u003cpath\u003e`: Path for the response (if you don’t want to use the default path).\n\n### Generate Request\n\n```bash\nbamimi-cli request:generate \u003crequestName\u003e [options]\n```\n\n- `requestName`: The name of the request you want to create.\n- `-p, --path \u003cpath\u003e`: Path for the request (if you don’t want to use the default path).\n\n### Generate Email\n\n```bash\nbamimi-cli email:generate \u003cemailName\u003e [options]\n```\n\n- `emailName`: The name of the email you want to create.\n- `-tn, --templateName \u003ctemplateName\u003e`: Template name if you want to use email with HTML.\n- `-job, --jobName \u003cjobName\u003e`: Job name if you want to use email with a queue job.\n\n### Generate Job\n\n```bash\nbamimi-cli job:generate \u003cjobName\u003e [options]\n```\n\n- `jobName`: The name of the job you want to create.\n- `-isc, --isSchedule \u003cisSchedule\u003e`: Job is schedule (y/n).\n  \n### Generate Interface\n\n```bash\nbamimi-cli itf:generate \u003cinterfaceName\u003e\n```\n- `interfaceName`: The name of the interface you want to create.\n  \n### Generate Docker\n\n```bash\nbamimi-cli docker:generate\n```\n### Generate Eslint\n\n```bash\nbamimi-cli lint:generate\n```\n\n### Generate TestConfig\n\n```bash\nbamimi-cli testConfig:generate\n```\n\n### Generate SQL config, structure, install dependency\n\n```bash\nbamimi-cli sql:generate\n```\n\n### Get version\n\n```bash\nbamimi-cli version:list-remote\n```\n\n### Build Project\n\n```bash\nbamimi-cli build \n```\n  \n## License\n\nBamimi CLI is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).\n\n## Author\n* [Kent Phung](https://github.com/khapu2906)\n\n## Owner\n* [KNFs JSC](https://github.com/knfs-jsc)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknfs-library%2Fbamimi-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknfs-library%2Fbamimi-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknfs-library%2Fbamimi-cli/lists"}