-
Notifications
You must be signed in to change notification settings - Fork 10
Improve examples #48
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.
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
Improve examples #48
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review completed. No suggestions at this time.
🤖 Automated review complete. Please react with 👍 or 👎 on the individual review comments to provide feedback on their usefulness.
🤖 Augment PR SummarySummary: Improves TypeScript SDK example documentation and GitHub Action indexer setup for smoother onboarding. Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review completed. 2 suggestions posted. Focused on correctness/consistency of the updated example docs and configuration.
Comment augment review to trigger a new review at any time.
| auggie login | ||
|
|
||
| # Print your credentials | ||
| auggie token print |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs/changelog refer to auggie tokens print; auggie token print may not exist and could break these setup steps. Consider updating this command to match the actual CLI subcommand (tokens print).
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| |-------------|-------------|----------| | ||
| | `AUGMENT_API_TOKEN` | Your Augment API token (can be a JSON object with `accessToken` and `tenantURL` fields, or a plain token string) | Yes | | ||
| | `AUGMENT_API_TOKEN` | Your Augment API token | Yes | | ||
| | `AUGMENT_API_URL` | Your tenant-specific Augment API URL (e.g., `https://your-tenant.api.augmentcode.com/`) | Yes | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that the indexer requires AUGMENT_API_URL, the bundled example workflow at examples/typescript-sdk/context/github-action-indexer/.github/workflows/index.yml will likely need to pass AUGMENT_API_URL too (it currently only sets AUGMENT_API_TOKEN). Otherwise users copying that workflow could hit a missing-env error.
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
richhankins
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Improve documentation and simplify authentication in TypeScript SDK examples.
Changes
@latesttag to allnpm install -g @augmentcode/auggiecommands across README files to ensure users install the most recent versionAUGMENT_API_TOKENandAUGMENT_API_URLenvironment variables instead of supporting multiple token formatsauggie token printImpact
These changes make the examples more maintainable and reduce confusion by:
🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.