search

awslabs / aws-shell

An integrated shell for working with the AWS CLI.
Apache License 2.0
7.15k stars 770 forks source link

add completions for Amazon Kinesis Stream #73

Closed quiver closed 8 years ago

quiver commented 8 years ago

Most Kinesis Stream API takes stream names as its parameters. This PR autocompletes Kinesis stream names.

Usage

$ aws-shell
$ aws-shell
aws> kinesis describe-stream --stream-name <TAB> # <- completes stream names
jamesls commented 8 years ago

Thanks!

donnemartin commented 8 years ago

Sweet! Maybe we can take this pull request as a sample/template for community members to help with adding more server side completions? Perhaps an update to the README and/or CONTRIBUTING that makes it easier for contributors to pitch in on this effort?

quiver commented 8 years ago

@donnemartin

Perhaps an update to the README and/or CONTRIBUTING that makes it easier for contributors to pitch in on this effort?

botocore has that kind of technical documentation. https://botocore.readthedocs.org/en/latest/index.html

+1 for hacking guide

jamesls commented 8 years ago

Yeah I'd like to add that. The server side completer is someone in flux right now.

The high level goal is to automatically derive these from boto's resource models (https://github.com/boto/boto3/tree/develop/boto3/data). The initial set of server side completions are entirely generated from boto3 resources. That being said, there's room for improvement. There's many more autocompletions we can derive from resources that aren't currently being done.

However, there's going to be times when a) the resource model doesn't have the info we need to figure out a service side completion or b) there's no resource model for a service, such as this scenario. In those cases the completions will need to be hand written.

I would like to put some "internals" documentation together for those that want to contribute.

donnemartin commented 8 years ago

:+1:

DanyC97 commented 8 years ago

:+1: