UNPKG

@symetrical/cli/README.md

Version:

2.02 kBMarkdownView Raw

1@symetrical/cli
2===============
3
4The Symetrical Framework CLI
5
6[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7[![Version](https://img.shields.io/npm/v/@symetrical/cli.svg)](https://npmjs.org/package/@symetrical/cli)
8[![Downloads/week](https://img.shields.io/npm/dw/@symetrical/cli.svg)](https://npmjs.org/package/@symetrical/cli)
9[![License](https://img.shields.io/npm/l/@symetrical/cli.svg)](https://github.com/tots/cli/blob/master/package.json)
10
11<!-- toc -->
12* [Usage](#usage)
13* [Commands](#commands)
14<!-- tocstop -->
15# Usage
16<!-- usage -->
17```sh-session
18$ npm install -g @symetrical/cli
19$ sm COMMAND
20running command...
21$ sm (-v|--version|version)
22@symetrical/cli/3.3.0 win32-x64 node-v8.15.0
23$ sm --help [COMMAND]
24USAGE
25  $ sm COMMAND
26...
27```
28<!-- usagestop -->
29# Commands
30<!-- commands -->
31* [`sm generate SCHEMATIC FILENAME`](#sm-generate-schematic-filename)
32* [`sm help [COMMAND]`](#sm-help-command)
33* [`sm new PROJECTNAME`](#sm-new-projectname)
34
35## `sm generate SCHEMATIC FILENAME`
36
37generates a new thing to a Symetrical RESTfull API
38
39```
40USAGE
41  $ sm generate SCHEMATIC FILENAME
42
43ARGUMENTS
44  SCHEMATIC  (route|r|provider|p|module|m) the schematic type to write the file as
45  FILENAME   where to write the file
46
47OPTIONS
48  -h, --help  show CLI help
49```
50
51_See code: [src\commands\generate.ts](https://gitlab.com/symetrical/symetrical-cli/blob/v3.3.0/src\commands\generate.ts)_
52
53## `sm help [COMMAND]`
54
55display help for sm
56
57```
58USAGE
59  $ sm help [COMMAND]
60
61ARGUMENTS
62  COMMAND  command to show help for
63
64OPTIONS
65  --all  see all commands in CLI
66```
67
68_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src\commands\help.ts)_
69
70## `sm new PROJECTNAME`
71
72creates a new RESTfull API
73
74```
75USAGE
76  $ sm new PROJECTNAME
77
78ARGUMENTS
79  PROJECTNAME  the name of the project to create
80
81OPTIONS
82  -h, --help  show CLI help
83```
84
85_See code: [src\commands\new.ts](https://gitlab.com/symetrical/symetrical-cli/blob/v3.3.0/src\commands\new.ts)_
86<!-- commandsstop -->

1	`@symetrical/cli`
2	`===============`
3
4	`The Symetrical Framework CLI`
5
6	`[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)`
7	`[![Version](https://img.shields.io/npm/v/@symetrical/cli.svg)](https://npmjs.org/package/@symetrical/cli)`
8	`[![Downloads/week](https://img.shields.io/npm/dw/@symetrical/cli.svg)](https://npmjs.org/package/@symetrical/cli)`
9	`[![License](https://img.shields.io/npm/l/@symetrical/cli.svg)](https://github.com/tots/cli/blob/master/package.json)`
10
11	`<!-- toc -->`
12	`* [Usage](#usage)`
13	`* [Commands](#commands)`
14	`<!-- tocstop -->`
15	`# Usage`
16	`<!-- usage -->`
17	```sh-session
18	`$ npm install -g @symetrical/cli`
19	`$ sm COMMAND`
20	`running command...`
21	`$ sm (-v\|--version\|version)`
22	`@symetrical/cli/3.3.0 win32-x64 node-v8.15.0`
23	`$ sm --help [COMMAND]`
24	`USAGE`
25	`$ sm COMMAND`
26	`...`
27	```
28	`<!-- usagestop -->`
29	`# Commands`
30	`<!-- commands -->`
31	* [`sm generate SCHEMATIC FILENAME`](#sm-generate-schematic-filename)
32	* [`sm help [COMMAND]`](#sm-help-command)
33	* [`sm new PROJECTNAME`](#sm-new-projectname)
34
35	## `sm generate SCHEMATIC FILENAME`
36
37	`generates a new thing to a Symetrical RESTfull API`
38
39	```
40	`USAGE`
41	`$ sm generate SCHEMATIC FILENAME`
42
43	`ARGUMENTS`
44	`SCHEMATIC (route\|r\|provider\|p\|module\|m) the schematic type to write the file as`
45	`FILENAME where to write the file`
46
47	`OPTIONS`
48	`-h, --help show CLI help`
49	```
50
51	`_See code: [src\commands\generate.ts](https://gitlab.com/symetrical/symetrical-cli/blob/v3.3.0/src\commands\generate.ts)_`
52
53	## `sm help [COMMAND]`
54
55	`display help for sm`
56
57	```
58	`USAGE`
59	`$ sm help [COMMAND]`
60
61	`ARGUMENTS`
62	`COMMAND command to show help for`
63
64	`OPTIONS`
65	`--all see all commands in CLI`
66	```
67
68	`_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src\commands\help.ts)_`
69
70	## `sm new PROJECTNAME`
71
72	`creates a new RESTfull API`
73
74	```
75	`USAGE`
76	`$ sm new PROJECTNAME`
77
78	`ARGUMENTS`
79	`PROJECTNAME the name of the project to create`
80
81	`OPTIONS`
82	`-h, --help show CLI help`
83	```
84
85	`_See code: [src\commands\new.ts](https://gitlab.com/symetrical/symetrical-cli/blob/v3.3.0/src\commands\new.ts)_`
86	`<!-- commandsstop -->`