Skip to content

Commit

Permalink
feat: add create project/module commands
Browse files Browse the repository at this point in the history
  • Loading branch information
eysi09 committed Jul 10, 2018
1 parent d3fc49d commit b611b35
Show file tree
Hide file tree
Showing 30 changed files with 1,389 additions and 252 deletions.
64 changes: 64 additions & 0 deletions docs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,70 @@ Note: Currently only supports HTTP/HTTPS endpoints.
| -------- | -------- | ----------- |
| `serviceAndPath` | Yes | The name of the service(s) to call followed by the endpoint path (e.g. my-container/somepath).

### garden create project

Creates a new Garden project.

The 'create project' command walks the user through setting up a new Garden project and
generates scaffolding based on user input.

Examples:

garden create project # creates a new Garden project in the current directory (project name defaults to
directory name)
garden create project my-project # creates a new Garden project in my-project directory
garden create project --module-dirs=path/to/modules1,path/to/modules2
# creates a new Garden project and looks for pre-existing modules in the modules1 and modules2 directories
garden create project --name my-project
# creates a new Garden project in the current directory and names it my-project

##### Usage

garden create project [project-dir] [options]

##### Arguments

| Argument | Required | Description |
| -------- | -------- | ----------- |
| `project-dir` | No | Directory of the project. (Defaults to current directory.)

##### Options

| Argument | Alias | Type | Description |
| -------- | ----- | ---- | ----------- |
| `--module-dirs` | | string | Relative path to modules directory. Use comma as a separator to specify multiple directories
| `--name` | | string | Assigns a custom name to the project. (Defaults to name of the current directory.)

### garden create module

Creates a new Garden module.

Creates a new Garden module of the given type

Examples:

garden create module # creates a new module in the current directory (module name defaults to directory name)
garden create module my-module # creates a new module in my-module directory
garden create module --type=container # creates a new container module
garden create module --name=my-module # creates a new module in current directory and names it my-module

##### Usage

garden create module [module-dir] [options]

##### Arguments

| Argument | Required | Description |
| -------- | -------- | ----------- |
| `module-dir` | No | Directory of the module. (Defaults to current directory.)

##### Options

| Argument | Alias | Type | Description |
| -------- | ----- | ---- | ----------- |
| `--name` | | boolean | Assigns a custom name to the module. (Defaults to name of the current directory.)
| `--type` | | string | Type of module. Check out 'https://docs.garden.io' for available types

### garden delete config

Delete a configuration variable from the environment.
Expand Down
Loading

0 comments on commit b611b35

Please sign in to comment.