Skip to content

docs(npm): lead with npx in README usage section #222

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

Closed
tkrugg wants to merge 1 commit into from
Closed

docs(npm): lead with npx in README usage section #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions npm/algolia/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,24 @@ The official Algolia CLI lets you manage your Algolia resources — indices, rec

> This package installs a prebuilt Go binary. The npm wrapper still requires Node.js to launch the installed command.

## Installation
## Usage

Run without installing:

```sh
npm install -g @algolia/cli
npx @algolia/cli --help
```

Or run without installing:
Or install globally:

```sh
npx @algolia/cli --help
npm install -g @algolia/cli
algolia --help
```

## Usage
## Examples

```sh
algolia --help
algolia search --index my-index --query "foo"
algolia indices list
algolia apikeys list
Expand Down
Loading