Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ljacobsson committed May 23, 2023
1 parent 441291a commit f5d857a
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
44 changes: 44 additions & 0 deletions README.md
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.
Empty file added commander
Empty file.
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env node
import { program } from 'commander';
import { Octokit } from '@octokit/rest';
import * as input from "./src/inputUtil.js";
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aws-sdk-v3-cli",
"version": "1.0.3",
"version": "1.0.4",
"description": "CLI tool that helps you find the right AWS SDK client for your use case",
"main": "index.js",
"type": "module",
Expand Down

0 comments on commit f5d857a

Please sign in to comment.