Skip to content

Update README.md#1086

Merged
archie-mckenzie merged 1 commit intomainfrom
a/npx-gt
Mar 7, 2026
Merged

Update README.md#1086
archie-mckenzie merged 1 commit intomainfrom
a/npx-gt

Conversation

@archie-mckenzie
Copy link
Contributor

@archie-mckenzie archie-mckenzie commented Mar 7, 2026

Greptile Summary

This PR adds a npx gt quick-start command block to the "Getting Started" section of README.md, providing users with an immediate call-to-action at the top of the documentation. The change is minimal and low-risk.

However, there is a consistency issue: the new "Getting Started" command uses npx gt without a version tag, while the existing "Quick Start" section (line 52) uses npx gt@latest. To ensure users consistently get the latest version and avoid locally cached packages, both commands should use the same form (npx gt@latest).

Confidence Score: 4/5

  • Safe to merge with minor version-tag consistency fix applied.
  • This PR is low-risk as it only modifies documentation. The single finding—a version tag inconsistency between the "Getting Started" command (npx gt) and the "Quick Start" command (npx gt@latest)—is valid and straightforward to address. Once the new command is updated to npx gt@latest for consistency, the change is safe to merge.
  • README.md — update line 20 from npx gt to npx gt@latest for consistency with line 52.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User visits README] --> B[Getting Started section]
    B --> C["npx gt - should be npx gt@latest"]
    C --> D[Description paragraph]
    D --> E[Documentation & API key links]
    E --> F[Quick Start section]
    F --> G["npx gt@latest"]
    G -.->|consistency issue| C
Loading

Last reviewed commit: 367dd96

Greptile also left 1 inline comment on this PR.

@archie-mckenzie archie-mckenzie requested a review from a team as a code owner March 7, 2026 03:53
@archie-mckenzie archie-mckenzie merged commit 81470f4 into main Mar 7, 2026
24 checks passed
@archie-mckenzie archie-mckenzie deleted the a/npx-gt branch March 7, 2026 03:53
## Getting Started

```bash
npx gt
Copy link
Contributor

Choose a reason for hiding this comment

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

Inconsistent version tag with Quick Start section

The newly added command uses npx gt without a version tag, but the existing "Quick Start" section at line 52 already recommends npx gt@latest. Using npx gt (without @latest) may execute a locally cached, potentially outdated version of the package. For consistency and to ensure users always run the newest version, this should match the existing command.

Suggested change
npx gt
npx gt@latest
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 20

Comment:
Inconsistent version tag with Quick Start section

The newly added command uses `npx gt` without a version tag, but the existing "Quick Start" section at line 52 already recommends `npx gt@latest`. Using `npx gt` (without `@latest`) may execute a locally cached, potentially outdated version of the package. For consistency and to ensure users always run the newest version, this should match the existing command.

```suggestion
npx gt@latest
```

How can I resolve this? If you propose a fix, please make it concise.

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.

1 participant