Skip to content

Add PowerShell installer and Windows setup instructions to README #184

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cosmind-rusu
Copy link

@cosmind-rusu cosmind-rusu commented May 8, 2025

What’s changed

  1. New install.ps1 script

    • Powershell installer to build kubectl-ai.exe on Windows (GOOS=windows, GOARCH=amd64).
    • Fully documented with English .SYNOPSIS/.DESCRIPTION/.PARAMETER/.EXAMPLE and console messages.
  2. README.md updates

    • Added Installation on Windows (PowerShell) section with download, build and install steps.
    • Added Environment Variable Configuration (PowerShell) section using setx … -m for persistent & global keys.
    • Translated all Windows/PowerShell snippets and headings into English.
    • Adjusted existing macOS/Linux install sections and cleaned up formatting.
    • Added “Start Contributing” footer link to contributing.md.

Why

  • Simplify Windows setup by providing a native PS script.
  • Offer clear, global environment variable instructions for all LLM providers.
  • Ensure documentation is cohesive and fully in English for cross-platform users.

How to test

  1. On Windows, run:
    .\install.ps1 -OutputPath .\kubectl-ai.exe

Copy link

google-cla bot commented May 8, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@cosmind-rusu cosmind-rusu changed the title Merge branch 'main' of https://github.com/GoogleCloudPlatform/kubectl-ai docs: add Windows installation guide and PowerShell build script for windows May 8, 2025
@cosmind-rusu cosmind-rusu changed the title docs: add Windows installation guide and PowerShell build script for windows Add PowerShell installer and Windows setup instructions to README May 8, 2025
@cosmind-rusu
Copy link
Author

Hi maintainers 👋,

I’ve put together this PR to streamline the Windows experience:

  1. install.ps1 – native PowerShell installer that builds kubectl‑ai.exe on GOOS=windows, GOARCH=amd64, with in‑script help (.SYNOPSIS / .DESCRIPTION / .PARAMETER / .EXAMPLE).
  2. README – new Installation on Windows (PowerShell) and Environment Variable Configuration sections, plus fully English headings, minor formatting clean‑ups, and a “Start Contributing” footer link.

Why it matters

  • Simplifies setup for Windows users.
  • Provides clear, cross‑platform environment‑variable guidance.
  • Keeps the documentation cohesive and 100 % in English.

I’d love your review and any suggestions you might have.
If there’s anything I should tweak, just let me know and I’ll update the PR promptly.

Thanks in advance!

@Nicki030
Copy link

Nicki030 commented May 9, 2025

To test the script, open PowerShell, run .\install.ps1 -OutputPath .\kubectl-ai.exe, and make sure the kubectl-ai.exe file is created with no errors shown.

@cosmind-rusu
Copy link
Author

Thanks, @Nicki030!
I’ve just followed those steps locally—kubectl‑ai.exe was generated without any errors.
Let me know if there’s anything else you’d like me to verify. 🙂

@droot
Copy link
Member

droot commented May 9, 2025

@cosmind-rusu thank yo for the PR and @Nicki030 thanks for verifying it.

I am planning to refactor the README because it is looking super busy right now. I will hold the PR for now. Most likely, we might want to have dedicated MD for installing on windows.

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.

4 participants