Skip to content

Commit

Permalink
update commands description
Browse files Browse the repository at this point in the history
  • Loading branch information
ianic committed Oct 4, 2021
1 parent 4a74045 commit bdc0589
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 22 deletions.
78 changes: 58 additions & 20 deletions commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## mantil --version
```
mantil version v0.1.7-134-ge5468e3
mantil version v0.1.10-7-g4a74045
```

## mantil --help
Expand All @@ -14,13 +14,13 @@ Available Commands:
aws AWS account subcommand
completion generate the autocompletion script for the specified shell
deploy Creates infrastructure and deploys updates to lambda functions
destroy Destroy all infrastructure resources
env Show project environment variables
generate Automatically generate code in the project
help Help about any command
invoke Makes requests to functions through project's API Gateway
logs Fetch logs for a specific function/api
new Initializes a new Mantil project
stage Manage project stages
test Run project integration tests
watch Watch for file changes and automatically deploy functions
Expand Down Expand Up @@ -144,49 +144,87 @@ Global Flags:
--no-color don't use colors in output
```

## mantil new --help
## mantil stage --help
```
Initializes a new Mantil project
Manage project stages
Usage:
mantil new <project> [flags]
mantil stage [command]
Available Commands:
destroy Destroy a stage
new Create a new stage
Flags:
--from string name of the template or URL of the repository that will be used as one
-h, --help help for new
--module-name string replace module name and import paths
-h, --help help for stage
Global Flags:
--no-color don't use colors in output
Use "mantil stage [command] --help" for more information about a command.
```

## mantil deploy --help
## mantil stage new --help
```
Creates infrastructure and deploys updates to lambda functions
Create a new stage
Usage:
mantil deploy [flags]
mantil stage new <name> [flags]
Flags:
-h, --help help for deploy
-s, --stage string name of the stage to deploy to, if the stage doesn't exist yet it will be created
-a, --account string account in which the stage will be created
-h, --help help for new
Global Flags:
--no-color don't use colors in output
```

## mantil stage destory --help
```
Manage project stages
Usage:
mantil stage [command]
Available Commands:
destroy Destroy a stage
new Create a new stage
Flags:
-h, --help help for stage
Global Flags:
--no-color don't use colors in output
Use "mantil stage [command] --help" for more information about a command.
```

## mantil destroy --help
## mantil new --help
```
Destroy all infrastructure resources
Initializes a new Mantil project
Usage:
mantil destroy [flags]
mantil new <project> [flags]
Flags:
--force don't ask for confirmation
-h, --help help for destroy
--repo delete local repository
-s, --stage string name of the stage to destroy, if left empty all stages will be destroyed
--from string name of the template or URL of the repository that will be used as one
-h, --help help for new
--module-name string replace module name and import paths
Global Flags:
--no-color don't use colors in output
```

## mantil deploy --help
```
Creates infrastructure and deploys updates to lambda functions
Usage:
mantil deploy [flags]
Flags:
-h, --help help for deploy
-s, --stage string name of the stage to deploy to
Global Flags:
--no-color don't use colors in output
Expand Down
8 changes: 6 additions & 2 deletions scripts/help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,19 @@ show mantil aws --help
show mantil aws install --help
show mantil aws uninstall --help

show mantil new --help
show mantil stage --help
show mantil stage new --help
show mantil stage destory --help

# project commands
show mantil new --help
show mantil deploy --help
show mantil destroy --help
show mantil env --help
show mantil invoke --help
show mantil logs --help
show mantil test --help
show mantil watch --help

# generate
show mantil generate --help
show mantil generate api --help

0 comments on commit bdc0589

Please sign in to comment.