Skip to content

Conversation

@igor0
Copy link
Contributor

@igor0 igor0 commented Dec 9, 2025

Improve documentation and simplify authentication in TypeScript SDK examples.

Changes

  • Standardize installation commands: Add @latest tag to all npm install -g @augmentcode/auggie commands across README files to ensure users install the most recent version
  • Simplify API credential handling: Remove JSON token parsing logic from GitHub Action Indexer examples, requiring explicit AUGMENT_API_TOKEN and AUGMENT_API_URL environment variables instead of supporting multiple token formats
  • Enhance setup documentation: Add detailed instructions in the GitHub Action Indexer README for obtaining API credentials using auggie token print

Impact

These changes make the examples more maintainable and reduce confusion by:

  • Ensuring users always get the latest CLI version during installation
  • Removing ambiguity around token format requirements
  • Providing clearer guidance for credential setup

🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.

@igor0 igor0 requested a review from richhankins December 9, 2025 20:27
Copy link

@github-actions github-actions bot left a 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-app-staging
Copy link

🤖 Augment PR Summary

Summary: Improves TypeScript SDK example documentation and GitHub Action indexer setup for smoother onboarding.

Changes:

  • Standardized CLI install instructions to use @latest across READMEs.
  • Simplified the GitHub Action indexer’s auth by requiring explicit AUGMENT_API_TOKEN and AUGMENT_API_URL (removed JSON token parsing).
  • Updated the indexer README and install script to reflect the new secrets and provide clearer credential acquisition guidance.

🤖 Was this summary useful? React with 👍 or 👎

Copy link

@augment-app-staging augment-app-staging bot left a 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.

Fix All in Augment

Comment augment review to trigger a new review at any time.

auggie login

# Print your credentials
auggie token print

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).

Fix This in Augment

🤖 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 |

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.

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Copy link
Contributor

@richhankins richhankins left a comment

Choose a reason for hiding this comment

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

LGTM

@igor0 igor0 merged commit 20593b5 into main Dec 9, 2025
2 checks passed
@igor0 igor0 deleted the improve-examples branch December 9, 2025 21:39
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