forked from deblan/gist
README
This commit is contained in:
parent
109b43cc77
commit
1f19a5f38a
43
README.md
43
README.md
|
@ -130,3 +130,46 @@ Params:
|
||||||
* Code ```405```: Method Not Allowed
|
* Code ```405```: Method Not Allowed
|
||||||
* Code ```400```: Bad Request
|
* Code ```400```: Bad Request
|
||||||
|
|
||||||
|
Console
|
||||||
|
-------
|
||||||
|
|
||||||
|
Gist provides a CLI for using API:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./app/console --help create
|
||||||
|
Usage:
|
||||||
|
create [options] [--] <input> [<type>]
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
input Input
|
||||||
|
type Type [default: "text"]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-t, --title=TITLE Title of the gist
|
||||||
|
-u, --show-url Display only the gist url
|
||||||
|
-h, --help Display this help message
|
||||||
|
-q, --quiet Do not output any message
|
||||||
|
-V, --version Display this application version
|
||||||
|
--ansi Force ANSI output
|
||||||
|
--no-ansi Disable ANSI output
|
||||||
|
-n, --no-interaction Do not ask any interactive question
|
||||||
|
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
|
||||||
|
|
||||||
|
Help:
|
||||||
|
The create provides a client to create a gist using an API.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
input
|
||||||
|
Identify the source of the content: path of the file (eg: /path/to/file) or standard input (-)
|
||||||
|
|
||||||
|
type
|
||||||
|
Defines the type of code: html, css, javascript, php, sql, xml, , perl, c, asp, python, bash, actionscript3, text
|
||||||
|
Default value: text
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--title, -t
|
||||||
|
Defines a title
|
||||||
|
|
||||||
|
--show-url, -u
|
||||||
|
Display only the url of the gist
|
||||||
|
```
|
||||||
|
|
|
@ -25,7 +25,7 @@ The <info>%command.name%</info> provides a client to create a gist using an API.
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<info>input</info>
|
<info>input</info>
|
||||||
Identify the source of the content: a file path (eg: <comment>/path/to/file</comment>) or standard input (<comment>-</comment>)
|
Identify the source of the content: path of the file (eg: <comment>/path/to/file</comment>) or standard input (<comment>-</comment>)
|
||||||
|
|
||||||
<info>type</info>
|
<info>type</info>
|
||||||
Defines the type of code: {$types}
|
Defines the type of code: {$types}
|
||||||
|
|
Loading…
Reference in a new issue