Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

amp help command #652

Merged
merged 1 commit into from
Jan 10, 2017
Merged

amp help command #652

merged 1 commit into from
Jan 10, 2017

Conversation

neha-viswanathan
Copy link
Contributor

@neha-viswanathan neha-viswanathan commented Jan 5, 2017 •
edited
Loading

Ref: #565 #604

Added amp help command, which mimicks docker help functionality. Also included the Long message to be displayed in the help command.
amp help <command> displays usage for a particular command.
However, using amp <command> help for certain commands like stats, info and config does not print usage.

$ amp help

Usage:	amp COMMAND

Appcelerator Microservice Platform.

Appcelerator Microservice Platform(AMP) is an open-source Container-as-a-Service (CaaS) platform 
for managing and monitoring containerized applications and microservices
as part of a unified serverless computing environment.

Options:
      --config-used         Display config file used (if any)
  -h, --help                Display help
      --server string       Server address
      --use-config string   Specify config file (overrides default at $HOME/.config/amp/amp.yaml)
  -v, --verbose             Verbose output
  -V, --version             Version number

Commands:
  config      Display or update the current configuration
  function    function operations
  help        Help about the command
  info        Display AMP version
  kv          Storage operations
  login       Login via GitHub
  logs        Fetch log entries matching provided criteria
  platform    Platform operations (alias: pf)
  registry    Registry operations
  service     Manage services
  stack       Stack operations
  stats       Display resource usage statistics
  topic       Topic operations
  version     Display the version info for AMP and Amplifier

Run 'amp COMMAND --help' for more information on a command.

@neha-viswanathan neha-viswanathan changed the title Added amp help command amp help command Jan 6, 2017
chrisccoy
chrisccoy reviewed Jan 6, 2017
View reviewed changes
cmd/amp/platform_monitor.go
@@ -9,7 +9,7 @@ import (
var PlatformMonitor = &cobra.Command{
Use: "monitor",
Short: "Display AMP platform services",
Long: `Display AMP platform services information and states.`,
Long: `Display command displays information about AMP platform services and states.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Display command displays information about AMP platform services and states
I think this should this be monitor ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

chrisccoy
chrisccoy reviewed Jan 6, 2017
View reviewed changes
Copy link
Contributor

@chrisccoy chrisccoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes LGTM, but there are a few minor wording changes that should be examined for the case of consistency. I outlined one example in the changes, but other similar cases exist.

freignat91
freignat91 approved these changes Jan 9, 2017
View reviewed changes
Copy link
Contributor

@freignat91 freignat91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Added amp help command
b4e4a03 
* Included Long message in help command output
@subfuzion subfuzion merged commit 0f8b975 into master Jan 10, 2017
freignat91
freignat91 reviewed Jan 10, 2017
View reviewed changes
Copy link
Contributor

@freignat91 freignat91 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.

generalhenry pushed a commit that referenced this pull request Jan 10, 2017
@subfuzion @generalhenry
Update from master (#672)
084ba9b 
* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* Add account API and CLI stubs (#661)

* Add account API and CLI stubs

* Assume -> Switch

* sp

* login story

* User stories to account command (#662)

* Add account API and CLI stubs

* Included sample stories for commands

* minor edit
generalhenry added a commit that referenced this pull request Jan 11, 2017
@generalhenry
Restore ui (#671)
dcb0d12 
* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* serverless prototype (#539)

* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* Revert "Amp version command - more useful info" (#611)

* Add functions to the ui (#605)

* KV ui (#606)

* Add functions to the ui

* add kv to ui

* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* remerge version
@bquenin bquenin deleted the amp-help-command branch January 11, 2017 10:02
subfuzion pushed a commit that referenced this pull request Jan 12, 2017
@subfuzion
Added amp help command (#652)
2ddaf41 
* Included Long message in help command output
@subfuzion subfuzion mentioned this pull request Jan 12, 2017
Merged
generalhenry pushed a commit that referenced this pull request Jan 12, 2017
@subfuzion @generalhenry
[v0.6.x] Cherrypicks (#681)
9ab92a8 
* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* fix proto files compilation (#664)

* remove amp-ui (#676)
bquenin pushed a commit that referenced this pull request Jan 12, 2017
@subfuzion
Update from master (#672)
f62f183 
* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* Add account API and CLI stubs (#661)

* Add account API and CLI stubs

* Assume -> Switch

* sp

* login story

* User stories to account command (#662)

* Add account API and CLI stubs

* Included sample stories for commands

* minor edit
bquenin pushed a commit that referenced this pull request Jan 12, 2017
@generalhenry
Restore ui (#671)
0b18d7a 
* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* serverless prototype (#539)

* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* Revert "Amp version command - more useful info" (#611)

* Add functions to the ui (#605)

* KV ui (#606)

* Add functions to the ui

* add kv to ui

* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* remerge version
bquenin pushed a commit that referenced this pull request Jan 12, 2017
@subfuzion
[v0.6.x] Cherrypicks (#681)
e1a5307 
* bump version to 0.6.0-dev

* Added amp help command (#652)

* Included Long message in help command output

* fix proto files compilation (#664)

* remove amp-ui (#676)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisccoy chrisccoy chrisccoy left review comments

@freignat91 freignat91 freignat91 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@neha-viswanathan @chrisccoy @freignat91 @subfuzion