Skip to content

docs: fix gws setup → gws auth setup#60

Merged
jpoehnelt merged 1 commit intomainfrom
docs/setup
Mar 4, 2026
Merged

docs: fix gws setup → gws auth setup#60
jpoehnelt merged 1 commit intomainfrom
docs/setup

Conversation

@jpoehnelt
Copy link
Copy Markdown
Member

Fixes #56 and #57.

The README documented gws setup in several places, but the correct command is gws auth setup. Users running gws setup got an "Unknown service 'setup'" error because setup isn't a registered API service.

Changes

  • Updated all 5 references in README.md from gws setup to gws auth setup

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 4, 2026

🦋 Changeset detected

Latest commit: 9641d6a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a documentation inaccuracy in the README.md by correcting the command used for Google Workspace CLI setup. The change ensures that users are guided to use the proper gws auth setup command, resolving issues where the previously documented gws setup led to errors and improving the overall user experience for initial setup and authentication.

Highlights

  • Documentation Correction: Updated all instances of gws setup to the correct command gws auth setup in README.md to prevent "Unknown service 'setup'" errors for users.
Changelog
  • .changeset/fix-setup-docs.md
    • Added a new changeset file to document the patch for the @googleworkspace/cli package.
  • README.md
    • Corrected five instances of gws setup to gws auth setup to reflect the accurate command for authentication setup.
    • Updated the command example for initial setup.
    • Modified the command for subsequent logins.
    • Adjusted the command in the manual OAuth setup section.
    • Updated the command in the API enablement tip.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@jpoehnelt jpoehnelt merged commit 3de9762 into main Mar 4, 2026
21 checks passed
@jpoehnelt jpoehnelt deleted the docs/setup branch March 4, 2026 18:57
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly updates all instances of gws setup to gws auth setup in the README.md file, addressing the reported issues regarding the incorrect command. The changes are accurate and directly resolve the documentation discrepancy.

Note: Security Review has been skipped due to the limited scope of the PR.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@206fd46). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #60   +/-   ##
=======================================
  Coverage        ?   54.09%           
=======================================
  Files           ?       35           
  Lines           ?    11320           
  Branches        ?        0           
=======================================
  Hits            ?     6123           
  Misses          ?     5197           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

shigechika pushed a commit to shigechika/gws-cli that referenced this pull request Mar 20, 2026
…eworkspace#57) (googleworkspace#60)

Co-authored-by: jpoehnelt-bot <jpoehnelt-bot@users.noreply.github.com>
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.

Missing command in docs

2 participants