minio/cmd/minio-cli/README.md

33 lines
708 B
Markdown
Raw Normal View History

2014-12-18 02:18:02 -08:00
## Introduction
`minio-cli` is cli option stub builder for ``minio`` project on top of [codegangsta/cli](https://github.com/codegangsta/cli),
2014-12-18 02:18:02 -08:00
Ideal for rapid prototyping and encouraging new contributors to the project
2014-12-18 02:18:02 -08:00
## Usage
You just need to set its command name and options:
2014-12-18 02:18:02 -08:00
```bash
$ minio-cli -options option1,option2,option3 [command]
2014-12-18 02:18:02 -08:00
```
Generates three files namely [command].go, [command]-options.go, [application].md
2014-12-18 02:18:02 -08:00
## Example
If you want to start to building `bucket` command which has options `get`, `put`, `list`:
2014-12-18 02:18:02 -08:00
```bash
$ minio-cli -options get,put,list foo
$ ls foo/
foo-options.go foo.go foo.md
```
## Installation
```bash
$ go get github.com/minio-io/minio
$ make install
```