-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ljacobsson
committed
May 23, 2023
1 parent
441291a
commit f5d857a
Showing
4 changed files
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# AWS SDK v3 CLI | ||
|
||
The AWS SDK v3 for Javascript is becoming the standard SDK for Javascript developers. However, due to [inconsistent naming](https://twitter.com/lajacobsson/status/1661103472446513152), it is not easy to find the service clients you need without going through the [documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). | ||
|
||
This is a command-line interface (CLI) tool for the AWS SDK v3. It allows you to search for aws-sdk-js service clients using free text search. | ||
|
||
## Prerequisites | ||
|
||
Before using this CLI tool, make sure you have the following: | ||
|
||
- Node.js installed on your system. | ||
- An environment variable named `GITHUB_TOKEN` set with your GitHub personal access token. You can create one [here](https://github.com/settings/tokens). | ||
|
||
## Installation | ||
|
||
To install the tool, run the following command: | ||
|
||
```shell | ||
npm install -g aws-sdk-cli | ||
``` | ||
|
||
## Usage | ||
|
||
Run the CLI tool using the following command: | ||
|
||
```shell | ||
aws-sdk [options] | ||
``` | ||
|
||
### Options | ||
|
||
The CLI tool supports the following options: | ||
|
||
- `--no-cache`: Use this option to disable cached results. By default, the tool uses cached results to improve performance. If you want to refresh the results, run the command with `--no-cache`. | ||
|
||
### Example | ||
|
||
```shell | ||
aws-sdk --no-cache | ||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters