close
Skip to content

docs: add npm install option to README - #223

Merged
LorrisSaintGenez merged 2 commits into
mainfrom
docs/readme-npm-install
Jun 2, 2026
Merged

LorrisSaintGenez merged 2 commits into
mainfrom
docs/readme-npm-install

Conversation

@tkrugg

@tkrugg tkrugg commented May 19, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Document @algolia/cli as an install option in the repo README.
  • Positioned above the OS-specific sections since npm works on every supported platform.

Test plan

  • Render the README on GitHub and confirm the new section is the first under Installation.

Related docs PR: https://github.com/algolia/docs-new/pull/839

🤖 Generated with Claude Code

Add `@algolia/cli` (npm) as the first install option in the README,
positioned above the OS-specific sections since it works on every
supported platform.
@codacy-production

codacy-production Bot commented May 19, 2026 •

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds npm-based installation guidance to the README so users can install or run the Algolia CLI through the published @algolia/cli package before platform-specific options.

Changes:

  • Adds an npm installation section under Installation.
  • Documents both npx @algolia/cli --help and global npm install usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@LorrisSaintGenez
LorrisSaintGenez merged commit cf3b617 into main Jun 2, 2026
2 of 3 checks passed
@LorrisSaintGenez
LorrisSaintGenez deleted the docs/readme-npm-install branch June 2, 2026 18:36
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
algolia 1.11.0

Created-by: HarmonybrewBot
Commit-by: HarmonybrewBot
Merged-by: HarmonybrewBot
Description: Created by `brew bump`

---

Created with `brew bump-formula-pr`.<details>
  <summary>release notes</summary>
  <pre>## What's Changed
* feat(open): add new dashboard shortcuts by @LorrisSaintGenez in algolia/cli#225
* feat(application): update/upgrade/downgrade/plans commands by @LorrisSaintGenez in algolia/cli#224
* docs: add npm install option to README by @tkrugg in algolia/cli#223
* feat(application): add name, tos and plan selection during application creation by @LorrisSaintGenez in algolia/cli#227
* feat(identify): send user data to identify after oauth flow by @LorrisSaintGenez in algolia/cli#228
* feat(application): more precise plan upgrade/downgrade direction by @LorrisSaintGenez in algolia/cli#226
* feat(telemetry): CLI flow events by @LorrisSaintGenez in algolia/cli#243
* feat: add auth get command by @levimichael in algolia/cli#253
* chore(api client): Upgrade Algolia Go API client by @tkrugg in algolia/cli#254
* fix: update 'auth get' to support refresh by @levimichael in algolia/cli#255
* feat(auth): Add token to `auth get` command by @levimichael in algolia/cli#257

## New Contributors
* @levimichael made their first contribution in algolia/cli#253

**Full Changelog**: https://github.com/algolia/cli/compare/v1.10.5...v1.11.0</pre>
  <p>View the full release notes at <a href="https://github.com/algolia/cli/releases/tag/v1.11.0">https://github.com/algolia/cli/releases/tag/v1.11.0</a>.</p>
</details>
<hr>

See merge request: Harmonybrew/homebrew-core!13019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants