0.0.17 • Published 4 years ago
osh-cli v0.0.17
osh
OmniStack Helper (osh) - Create your JS and TS components and more
Usage
$ npm install -g osh-cli
$ osh COMMAND
running command...
$ osh (-v|--version|version)
osh-cli/0.0.16 darwin-x64 node-v12.16.3
$ osh --help [COMMAND]
USAGE
$ osh COMMAND
...
Commands
osh autocomplete [SHELL]
osh create:api
osh create:component COMPONENT-NAME
osh create:page PAGE-NAME
osh create:route ROUTE-NAME
osh help [COMMAND]
osh autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ osh autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ osh autocomplete
$ osh autocomplete bash
$ osh autocomplete zsh
$ osh autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
osh create:api
Create the api service with axios inside src/services
USAGE
$ osh create:api
OPTIONS
-h, --help show CLI help
-p, --path=src/services [default: src/services] change the path to your api service
--ts make with TypeScript
ALIASES
$ osh capi
EXAMPLES
$ osh create:api --ts
$ osh create:api --path src/utils
$ osh capi --ts
See code: src/commands/create/api.ts
osh create:component COMPONENT-NAME
Create new component inside src/components
USAGE
$ osh create:component COMPONENT-NAME
ARGUMENTS
COMPONENT-NAME Name of the component
OPTIONS
-h, --help show CLI help
-i, --index=index create index file to export for default your components
-p, --path=src/components [default: src/components] change the path to your component
--ts make with TypeScript
ALIASES
$ osh cc
EXAMPLES
$ osh create:component Button
$ osh create:component Input --ts
$ osh create:component --path=src/otherFolder Input
$ osh create:component MyInput -i=Form
See code: src/commands/create/component.ts
osh create:page PAGE-NAME
Create new page inside src/pages
USAGE
$ osh create:page PAGE-NAME
ARGUMENTS
PAGE-NAME Name of the page
OPTIONS
-h, --help show CLI help
-p, --path=src/pages [default: src/pages] change the path to your page
--ts make with TypeScript
ALIASES
$ osh cp
EXAMPLES
$ osh create:page SignIn
$ osh create:page -p=src/screens SignUp
$ osh create:page Dashboard --ts
See code: src/commands/create/page.ts
osh create:route ROUTE-NAME
Create new express route.(ts|js) inside src/routes
USAGE
$ osh create:route ROUTE-NAME
ARGUMENTS
ROUTE-NAME Name of route file
OPTIONS
-h, --help show CLI help
-p, --path=src/routes [default: src/routes] change the path to your route
--ts make with TypeScript
ALIASES
$ osh cr
EXAMPLE
$ osh create:route users
See code: src/commands/create/route.ts
osh help [COMMAND]
display help for osh
USAGE
$ osh help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help