{"id":22765241,"url":"https://github.com/rucken/cli","last_synced_at":"2025-08-09T04:30:37.235Z","repository":{"id":57139132,"uuid":"112372557","full_name":"rucken/cli","owner":"rucken","description":"Console tools for create and build Angular7+, Bootstrap, Ionic and NestJS application based on Rucken template","archived":false,"fork":false,"pushed_at":"2020-12-29T09:42:52.000Z","size":13884,"stargazers_count":10,"open_issues_count":41,"forks_count":3,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2024-06-04T11:31:43.154Z","etag":null,"topics":["admin","angular7","application","backend","boilerplate","bootstrap","cli","frontend","i18n","ionic","mobile","nestjs","ngx","nx","rucken","seed","ssr","ui","utils","workspace"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@rucken/cli","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/rucken.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}},"created_at":"2017-11-28T18:23:40.000Z","updated_at":"2020-12-29T09:42:55.000Z","dependencies_parsed_at":"2022-09-03T13:53:14.420Z","dependency_job_id":null,"html_url":"https://github.com/rucken/cli","commit_stats":null,"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rucken%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rucken%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rucken%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rucken%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rucken","download_url":"https://codeload.github.com/rucken/cli/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229222354,"owners_count":18039285,"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":["admin","angular7","application","backend","boilerplate","bootstrap","cli","frontend","i18n","ionic","mobile","nestjs","ngx","nx","rucken","seed","ssr","ui","utils","workspace"],"created_at":"2024-12-11T12:12:19.735Z","updated_at":"2024-12-11T12:12:20.474Z","avatar_url":"https://github.com/rucken.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"@rucken/cli\n===========\n\nConsole tools for create and build [Angular7+](https://angular.io/), [Ionic](https://ionicframework.com/), [Bootstrap](https://valor-software.com/ngx-bootstrap/#/) and [NestJS](https://nestjs.com/) application based on [Rucken](https://rucken.ru) template\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Greenkeeper badge](https://badges.greenkeeper.io/rucken/cli.svg)](https://greenkeeper.io/)\n[![Version](https://img.shields.io/npm/v/@rucken/cli.svg)](https://npmjs.org/package/@rucken/cli)\n[![Build Status][travis-image]][travis-url]\n[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/rucken/cli?branch=master\u0026svg=true)](https://ci.appveyor.com/project/rucken/cli/branch/master)\n[![Codecov](https://codecov.io/gh/rucken/cli/branch/develop/graph/badge.svg)](https://codecov.io/gh/rucken/cli)\n[![Downloads/week](https://img.shields.io/npm/dw/@rucken/cli.svg)](https://npmjs.org/package/@rucken/cli)\n[![License](https://img.shields.io/npm/l/@rucken/cli.svg)](https://github.com/rucken/cli/blob/master/package.json)\n[![Gitter][gitter-image]][gitter-url]\n[![Join the chat at telegram][telegram-image]][telegram-url]\n\n* [Install](#install)\n* [Usage](#usage)\n* [Generators](#generators)\n* [Commands](#commands)\n\n# Install\n\u003c!-- install --\u003e\n```bash\n$ npm install -g @rucken/cli\n```\n\u003c!-- installstop --\u003e\n# Usage\n\u003c!-- ussage --\u003e\n```bash\n# create workspace\nrucken workspace my-workspace\n# move to created workspace\ncd my-workspace\n# create applications\nrucken app app-name --type=web --type=nestjs\n# create libraries\nrucken lib lib-name --type=frontend --type=nestjs\n# create entities in libraries\nrucken entity entity-name --type=web --type=nestjs\n# create link entities to applications\nrucken entity2app --type=web --type=nestjs\n# create link libraries to applications\nrucken lib2app --type=frontend --type=nestjs\n# install dependencies\nnpm i\nng serve app-name\n```\n\u003c!-- ussagestop --\u003e\n\n\u003c!-- changelogsstop --\u003e\n# Generators\n\u003c!-- generators --\u003e\n* [`rucken generator-workspace [NAME]`](#rucken-generator-workspace-name)\n* [`rucken generator-application [NAME]`](#rucken-generator-application-name)\n* [`rucken generator-entity [NAME]`](#rucken-generator-entity-name)\n* [`rucken generator-entity-to-application [NAME]`](#rucken-generator-entity-to-application-name)\n* [`rucken generator-library [NAME]`](#rucken-generator-library-name)\n* [`rucken generator-library-to-application [NAME]`](#rucken-generator-library-to-application-name)\n\n## `rucken generator-workspace [NAME]`\n\nWorkspace generator, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-workspace [NAME]\n\nOPTIONS\n  -a, --author=author        Author name (it is recommended to use Github user for better integration).\n  -e, --email=email          Author email name.\n  -h, --help                 show CLI help\n  -t, --template=template    [default: @rucken/schematics:workspace] Template name.\n  -w, --workspace=workspace  The workspace directory name.\n\nALIASES\n  $ rucken workspace\n  $ rucken ws\n```\n\n_See code: [src/commands/generator-workspace.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-workspace.ts)_\n\n## `rucken generator-application [NAME]`\n\nApplication generator, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-application [NAME]\n\nOPTIONS\n  -a, --author=author              Author name (it is recommended to use Github user for better integration).\n  -e, --email=email                Author email name.\n  -h, --help                       show CLI help\n  -t, --type=web|ionic|nestjs|all  Type(s) of applications.\n  -w, --workspace=workspace        The workspace directory name.\n\n  --api=api                        [default: /api] The backend api address (/api, http://host.com/api,\n                                   https://api.host.com).\n\n  --ionicTemplate=ionicTemplate    [default: @rucken/schematics:rucken-app-ionic] Mobile frontend generator application\n                                   on Angular7+ with Ionic4\n\n  --nestjsTemplate=nestjsTemplate  [default: @rucken/schematics:rucken-app-nestjs] REST generator backend applications\n                                   on NestJS with TypeORM\n\n  --webTemplate=webTemplate        [default: @rucken/schematics:rucken-app] Frontend application generator on Angular7+\n                                   with Bootstrap3\n\nALIASES\n  $ rucken application\n  $ rucken app\n```\n\n_See code: [src/commands/generator-application.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-application.ts)_\n\n## `rucken generator-entity [NAME]`\n\nThe generator of the entity, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-entity [NAME]\n\nOPTIONS\n  -h, --help                       show CLI help\n  -t, --type=web|ionic|nestjs|all  Type(s) of entities.\n  -w, --workspace=workspace        The workspace directory name.\n  --coreLib=coreLib                The name of the core library.\n  --coreTemplate=coreTemplate      [default: @rucken/schematics:rucken-entity] Model generator and frontend application\n  --ionicLib=ionicLib              The name of the ionic library.\n\n  --ionicTemplate=ionicTemplate    [default: @rucken/schematics:rucken-entity-ionic] The generator of the main\n                                   components for editing data on the model and for a mobile frontend application on\n                                   Angular7+ with Ionic4\n\n  --lib=lib                        The name of the library.\n\n  --nestjsLib=nestjsLib            The name of the nestjs library.\n\n  --nestjsTemplate=nestjsTemplate  [default: @rucken/schematics:rucken-entity-nestjs] The generator of the entity, the\n                                   DTO, the service and the controller, for editing the entity data for the backend of\n                                   the application on NestJS with TypeORM\n\n  --timestamp=timestamp            Timestamp used in migrations.\n\n  --webLib=webLib                  The name of the web library.\n\n  --webTemplate=webTemplate        [default: @rucken/schematics:rucken-entity-web] The generator of the main components\n                                   for editing data on the model and for the frontend application on Angular7+ with\n                                   Bootstrap3\n\nALIASES\n  $ rucken entity\n```\n\n_See code: [src/commands/generator-entity.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-entity.ts)_\n\n## `rucken generator-entity-to-application [NAME]`\n\nLinking the entity to the application, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-entity-to-application [NAME]\n\nOPTIONS\n  -h, --help                     show CLI help\n  -t, --type=web|ionic|all       Type(s) of applications.\n  -w, --workspace=workspace      The workspace directory name.\n  --app=app                      The name of the application.\n  --coreLib=coreLib              The name of the core library with entity.\n  --ionicApp=ionicApp            The name of the ionic application.\n  --ionicLib=ionicLib            The name of the ionic library with entity.\n\n  --ionicTemplate=ionicTemplate  [default: @rucken/schematics:rucken-entity-ionic-to-app] Binding components for editing\n                                 an entity to a mobile frontend application on Angular7+ with Ionic4\n\n  --lib=lib                      The name of the library with entity.\n\n  --webApp=webApp                The name of the web application.\n\n  --webLib=webLib                The name of the web library with entity.\n\n  --webTemplate=webTemplate      [default: @rucken/schematics:rucken-entity-web-to-app] Binding of components for\n                                 editing an entity to a frontend application on Angular7+ with Bootstrap3\n\nALIASES\n  $ rucken entity-to-application\n  $ rucken entity-to-app\n  $ rucken entity2app\n```\n\n_See code: [src/commands/generator-entity-to-application.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-entity-to-application.ts)_\n\n## `rucken generator-library [NAME]`\n\nLibrary generator, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-library [NAME]\n\nOPTIONS\n  -a, --author=author                  Author name (it is recommended to use Github user for better integration).\n  -e, --email=email                    Author email name.\n  -h, --help                           show CLI help\n  -o, --org=org                        The name of organization.\n  -t, --type=frontend|nestjs|all       Type(s) of library.\n  -w, --workspace=workspace            The workspace directory name.\n  --frontendTemplate=frontendTemplate  [default: @rucken/schematics:rucken-lib] Frontend library generator\n\n  --nestjsTemplate=nestjsTemplate      [default: @rucken/schematics:rucken-lib-nestjs] Backend library generator on\n                                       NestJS\n\nALIASES\n  $ rucken library\n  $ rucken lib\n```\n\n_See code: [src/commands/generator-library.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-library.ts)_\n\n## `rucken generator-library-to-application [NAME]`\n\nLinking the library to the application, based on the Rucken template\n\n```\nUSAGE\n  $ rucken generator-library-to-application [NAME]\n\nOPTIONS\n  -h, --help                           show CLI help\n  -t, --type=frontend|nestjs|all       Type(s) of applications.\n  -w, --workspace=workspace            The workspace directory name.\n  --app=app                            The name of the application.\n  --frontendApp=frontendApp            The name of the frontend application.\n  --frontendLib=frontendLib            The name of the frontend library.\n  --frontendTemplate=frontendTemplate  [default: @rucken/schematics:rucken-lib-to-app] Frontend library generator\n  --lib=lib                            The name of the library.\n  --nestjsApp=nestjsApp                The name of the nestjs application.\n  --nestjsLib=nestjsLib                The name of the nestjs library.\n\n  --nestjsTemplate=nestjsTemplate      [default: @rucken/schematics:rucken-lib-nestjs-to-app] Linking the library to the\n                                       backend application on NestJS\n\nALIASES\n  $ rucken library-to-application\n  $ rucken lib-to-app\n  $ rucken lib2app\n```\n\n_See code: [src/commands/generator-library-to-application.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/generator-library-to-application.ts)_\n\n\u003c!-- generatorsstop --\u003e\n\n# Commands\n\u003c!-- commands --\u003e\n* [`rucken config [FOLDER]`](#rucken-config-folder)\n* [`rucken help [COMMAND]`](#rucken-help-command)\n* [`rucken make-ts-list [FOLDER]`](#rucken-make-ts-list-folder)\n* [`rucken prepare [FOLDER]`](#rucken-prepare-folder)\n* [`rucken translate [FOLDER]`](#rucken-translate-folder)\n* [`rucken version-updater [FOLDER]`](#rucken-version-updater-folder)\n\n## `rucken config [FOLDER]`\n\nchange angular.json properties and tsconfig.json properties for switch between dev - for speedup mono serve mode and prod - build optimization and standalone build all lib and application\n\n```\nUSAGE\n  $ rucken config [FOLDER]\n\nOPTIONS\n  -h, --help             show CLI help\n  -m, --mode=(dev|prod)  [default: prod]\n```\n\n_See code: [src/commands/config.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/config.ts)_\n\n## `rucken help [COMMAND]`\n\ndisplay help for rucken\n\n```\nUSAGE\n  $ rucken help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_\n\n## `rucken make-ts-list [FOLDER]`\n\nmake index.ts with list of ts files recursive from source folder\n\n```\nUSAGE\n  $ rucken make-ts-list [FOLDER]\n\nOPTIONS\n  -e, --excludes=excludes            [default: *server*,*node_modules*,*public_api.ts*,*test.ts*,*.spec*,environment*]\n                                     exclude directories/files masks\n\n  -h, --help                         show CLI help\n\n  -i, --indexFileName=indexFileName  [default: index.ts] output file\n```\n\n_See code: [src/commands/make-ts-list.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/make-ts-list.ts)_\n\n## `rucken prepare [FOLDER]`\n\ntranslate + make-ts-list + version-update + config\n\n```\nUSAGE\n  $ rucken prepare [FOLDER]\n\nOPTIONS\n  -h, --help             show CLI help\n  -m, --mode=(dev|prod)\n```\n\n_See code: [src/commands/prepare.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/prepare.ts)_\n\n## `rucken translate [FOLDER]`\n\nextract translate from source and make ts class from it\n\n```\nUSAGE\n  $ rucken translate [FOLDER]\n\nOPTIONS\n  -c, --clean                      remove obsolete strings when merging\n  -e, --excludes=excludes          [default: [\"*node_modules*,*.spec\"]] exclude directories/files masks\n  -f, --format=(po|json)           [default: po] file prefix and build mode\n  -h, --help                       show CLI help\n  -p, --prefix=prefix              name of class prefix\n  -t, --templateName=templateName  [default: template] name of template\n```\n\n_See code: [src/commands/translate.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/translate.ts)_\n\n## `rucken version-updater [FOLDER]`\n\nlibraries dependencies and package.json versions updater from root package.json\n\n```\nUSAGE\n  $ rucken version-updater [FOLDER]\n\nOPTIONS\n  -h, --help       show CLI help\n  -r, --root=root  [default: .] root project with package.json for get inforamtion about dependencies and it versions\n```\n\n_See code: [src/commands/version-updater.ts](https://github.com/rucken/cli/blob/v4.0.0/src/commands/version-updater.ts)_\n\u003c!-- commandsstop --\u003e\n\n[travis-image]: https://travis-ci.org/rucken/cli.svg?branch=master\n[travis-url]: https://travis-ci.org/rucken/cli\n[gitter-image]: https://img.shields.io/gitter/room/rucken/cli.js.svg\n[gitter-url]: https://gitter.im/rucken/cli\n[dependencies-image]: https://david-dm.org/rucken/cli/status.svg\n[dependencies-url]: https://david-dm.org/rucken/cli\n[telegram-image]: https://img.shields.io/badge/chat-telegram-blue.svg?maxAge=2592000\n[telegram-url]: https://t.me/rucken\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frucken%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frucken%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frucken%2Fcli/lists"}