Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rkoval committed Jul 24, 2020
1 parent ed2a5ba commit ef5f40d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,18 @@ To use, activate Alfred and type `aws ` to trigger this workflow. From there:
- press <kbd>Tab</kbd> to autocomplete into sub-services, if they exist (for example, navigate to "Security Groups" within the "EC2" service)
- keep typing after autocompleting to filter sub-services
- press <kbd>Tab</kbd> again within sub-services to autocomplete the sub-service and start searching for its entities (for example, you can search for EC2 Instances when tabbed to `aws ec2 instances `)
- `,` is a sub-section alias to start searching for the default entity type associated with a service (for example, in this workflow, the EC2 service's default entity is an EC2 instance, so `aws ec2 ,searchterm` is a shorter alias for `aws ec2 instances searchterm`). You can customize this alias by setting the `ALFRED_AWS_CONSOLE_SERVICES_WORKFLOW_SEARCH_ALIAS` environment variable to any other string.

At any time:
- press <kbd>Enter</kbd> to navigate to your result
- press <kbd>⌘</kbd>+<kbd>Enter</kbd> to copy the URL to clipboard.
- press <kbd>Enter</kbd> to open the result in your default browser
- press <kbd>⌘</kbd>+<kbd>Enter</kbd> to copy the result's URL to clipboard.

*Note that you must be logged in for the page to open directly to your service*. See [this config file](console-services.yml) for the full list of supported services and their sub-services and [this file](https://github.com/rkoval/alfred-aws-console-services-workflow/blob/master/searchtypes/search_types.go) for the list of supported searchers.

## Advanced Usage

- [Fuzzy filtering](https://godoc.org/github.com/deanishe/awgo/fuzzy) a la Sublime Text is supported
- `,` is a sub-section alias to start searching for the default entity type associated with a service. For example, in this workflow, the EC2 service's default entity is an EC2 instance, so `aws ec2 ,searchterm` is a shorter alias for `aws ec2 instances searchterm`. You can customize this alias by setting the `ALFRED_AWS_CONSOLE_SERVICES_WORKFLOW_SEARCH_ALIAS` environment variable to any other string.

## Contributing

See [this README](CONTRIBUTING.md)
Expand Down

0 comments on commit ef5f40d

Please sign in to comment.