{"id":13561584,"url":"https://github.com/omni-door/cli","last_synced_at":"2025-04-03T17:31:14.186Z","repository":{"id":43976468,"uuid":"218483160","full_name":"omni-door/cli","owner":"omni-door","description":"🐸  The command-line interface for set up a standard frontend project (react-spa, vue-spa, react-ssr, react-component, vue-component, toolkit)","archived":false,"fork":false,"pushed_at":"2023-02-03T11:31:35.000Z","size":3526,"stargazers_count":41,"open_issues_count":12,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-23T16:40:29.834Z","etag":null,"topics":["cli","next-cli","nextjs-cli","omni","omni-door","react","react-cli","spa-cli","ssr-cli","toolkit-cli"],"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/omni-door.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2019-10-30T08:51:26.000Z","updated_at":"2023-09-03T02:16:56.000Z","dependencies_parsed_at":"2023-02-05T02:45:32.647Z","dependency_job_id":null,"html_url":"https://github.com/omni-door/cli","commit_stats":{"total_commits":730,"total_committers":4,"mean_commits":182.5,"dds":"0.39315068493150684","last_synced_commit":"1705432463820c2180ae6c6015001e74b009c479"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omni-door%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omni-door%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omni-door%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omni-door%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omni-door","download_url":"https://codeload.github.com/omni-door/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247046893,"owners_count":20874736,"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","next-cli","nextjs-cli","omni","omni-door","react","react-cli","spa-cli","ssr-cli","toolkit-cli"],"created_at":"2024-08-01T13:00:58.824Z","updated_at":"2025-04-03T17:31:09.178Z","avatar_url":"https://github.com/omni-door.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 🐸 @omni-door/cli\n\nhttps://www.omnidoor.org\n\nThe CLI Tool for set up standard frontend project.\n\n[![NPM downloads](http://img.shields.io/npm/dm/%40omni-door%2Fcli.svg?style=flat-square)](https://www.npmjs.com/package/@omni-door/cli)\n[![npm version](https://badge.fury.io/js/%40omni-door%2Fcli.svg)](https://badge.fury.io/js/%40omni-door%2Fcli)\n[![node version](https://img.shields.io/badge/node.js-%3E=_10.13.0-green.svg?style=flat-square)](http://nodejs.org/download/)\n[![Build Status](https://travis-ci.com/omni-door/cli.svg?branch=master)](https://travis-ci.com/omni-door/cli)\n[![codecov](https://codecov.io/gh/omni-door/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/omni-door/cli)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![install size](https://packagephobia.now.sh/badge?p=%40omni-door%2Fcli)](https://packagephobia.now.sh/result?p=%40omni-door%2Fcli)\n[![license](http://img.shields.io/npm/l/%40omni-door%2Fcli.svg)](https://github.com/omni-door/cli/blob/master/LICENSE)\n\n\n\u003cimg src='./docs/omni-init.gif' width='800px' height='500px' /\u003e\n\n\nEnglish | [简体中文](./docs/README.zh-CN.md)\n\n[\u003comni.config.js\u003e DETAILS](./docs/OMNI.md)\n\n[CHANGELOG](./docs/CHANGELOG.md)\n\n## install\nThe latest LTS version of Node.js is recommended, or at least ensure node \u003e= 10.13.0\n\nSeveral options to get up and running:\n\n* Clone the repo: `git@github.com:omni-door/cli.git`\n\n* Install with [npm](https://www.npmjs.com/package/@omni-door/cli): `npm install @omni-door/cli -g`\n\n* Install with [Yarn](https://yarnpkg.com/en/package/@omni-door/cli): `yarn global add @omni-door/cli`\n\n* Initial project with [npx](https://www.npmjs.com/package/@omni-door/cli): `npx @omni-door/cli init`\n\n## omni --help\n```shell\n  Usage: index [command] [options]\n\n  Options:\n\n    -v, --version   output the version number\n    -h, --help      output usage information\n\n  Commands:\n\n    init [options] [strategy]  initialize your project, [strategy] could be stable(default) or latest\n    dev [options]              omni dev [-p \u003cport\u003e] [-H \u003chost\u003e] [-P \u003cpath\u003e]\n    start [options]            omni start [-p \u003cport\u003e] [-H \u003chost\u003e] [-P \u003cpath\u003e]\n    new [options] [name]       omni new [name] [-f | -c] [-P \u003cpath\u003e]\n    build [options]            build your project according to the [omni.config.js]'s build field\n    release [options]          publish your project according to the [omni.config.js]'s release field\n\n```\n\n## omni init\n\n### Initial your project by answer several questions\n```shell\nomni init\n```\n\n### Initial your project with lastest denpendencies\n```shell\nomni init lastest\n```\n\n### Initial your project without install dependencies\n```shell\nomni init -n\n```\n\n### Initial your project according to some template\n```shell\nomni init -t [projectName]\n```\nor\n```shell\nomni init --react_entire [projectName]\n```\n\n### options\n```shell\nUsage: omni init [strategy] [options]\n\ninitialize your project, [strategy] could be stable(default) or latest\n\nArguments:\n\n  strategy                 stable or latest\n\nOptions:\n  -rb, --react_basic [name]       create a basic React SPA project\n  -rs, --react_standard [name]    create a standard React SPA project\n  -re, --react_entire [name]        create a most versatile React SPA project\n  -rp, --react_pc [name]          create a React SPA project based on Antd\n  -vb, --vue_basic [name]         create a basic Vue SPA project\n  -vs, --vue_standard [name]      create a standard Vue SPA project\n  -ve, --vue_entire [name]        create a most versatile Vue SPA project\n  -rS, --react_ssr [name]         create a React component library\n  -rc, --react_components [name]  create a React component library\n  -vc, --vue_components [name]    create a Vue component library\n  -t, --toolkit [name]            create a toolkit project\n  -n, --no-install                init project without install dependencies\n  -P, --path \u003cpath\u003e               the workpath for init the project\n  -h, --help                      output usage information\n```\n\n---\n\n## omni dev\n\n### options\n```shell\nUsage: omni dev [options]\n\nomni dev [-p \u003cport\u003e] [-H \u003chost\u003e] [-P \u003cpath\u003e]\n\nOptions:\n  -p, --port \u003cport\u003e      start the dev-server according to the specified port\n  -H, --hostname \u003chost\u003e  start the dev-server according to the specified hostname\n  -P, --path \u003cpath\u003e      the workpath for start the dev-server\n  -h, --help             output usage information\n```\n\n---\n\n## omni start\n\n### options\n```shell\nUsage: omni start [options]\n\nomni start [-p \u003cport\u003e] [-H \u003chost\u003e] [-P \u003cpath\u003e]\n\nOptions:\n  -p, --port \u003cport\u003e      start the prod-server according to the specified port\n  -H, --hostname \u003chost\u003e  start the prod-server according to the specified hostname\n  -P, --path \u003cpath\u003e      the workpath for start the prod-server\n  -h, --help             output usage information\n```\n\n---\n\n## omni new\n\n### options\n```shell\nUsage: omni new [name] [options]\n\nomni new [name] [-f | -c] [-P \u003cpath\u003e]\n\nArguments:\n\n  name              optional! The name of component.\n\nOptions:\n  -f, --function     create a React-Function-Component\n  -c, --class        create a React-Class-Component\n  -r, --render       create a Vue-Render-Function\n  -s, --single       create a Vue-Single-File-Component\n  -P, --path \u003cpath\u003e  the workpath for create component\n  -h, --help         display help for command\n```\n\n---\n\n## omni build\n\n### options\n```shell\nUsage: omni build [options]\n\nbuild your project according to the [omni.config.js]'s build field\n\nOptions:\n  -c, --config \u003cpath\u003e  specify the path of config file\n  -n, --no-verify      bypass all pre-check before building\n  -P, --path \u003cpath\u003e    the workpath for build project\n  -h, --help           output usage information\n```\n\n---\n\n## omni release\n\n### options\n```shell\nUsage: omni release [options]\n\npublish your project according to the [omni.config.js]'s release field\n\nOptions:\n  -a, --automatic         automatic iteration version\n  -i, --ignore            ignore automatic iteration version\n  -m, --manual \u003cversion\u003e  manual iteration version\n  -t, --tag \u003ctag\u003e         the tag will add to npm-package\n  -n, --no-verify         bypass unit-test eslint and stylelint check\n  -P, --path \u003cpath\u003e       the workpath for release project\n  -h, --help              output usage information\n```\n\n---\n\n## API Docs\nclick [here](./docs/DEV.md)\n\n## License\n\nCopyright (c) 2019 [Bobby.li](https://github.com/BobbyLH)\n\nReleased under the MIT License","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomni-door%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomni-door%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomni-door%2Fcli/lists"}