gcw 0.1.0__tar.gz

gcw-0.1.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,21 @@
+---
+name: Bug
+about: Something in gcw does not work as described
+labels: bug
+---
+
+## What happened
+
+The command you ran and what it did. For a wrong page, add the URL from the same command with `-n`; it never contains your email address.
+
+```
+$ gcw …
+```
+
+## What you expected
+
+## Environment
+
+- `gcw --version`:
+- `gcloud --version` (first line):
+- OS and shell (e.g. Ubuntu 24.04, bash; macOS, zsh; Windows, Git Bash):

gcw-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

gcw-0.1.0/.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,23 @@
+---
+name: Feature
+about: Planned work on gcw, with tasks to tick
+labels: enhancement
+---
+
+## Context
+
+Why this is needed. Link related ADRs and issues.
+
+## Plan
+
+How it should work: commands and their behaviour, examples.
+
+## Tasks
+
+- [ ] …
+- [ ] Tests (no network, no real gcloud configuration)
+- [ ] README and docs, if behaviour changes
+
+## Done when
+
+A check anyone can run, e.g. a command and what it prints or opens.

gcw-0.1.0/.github/ISSUE_TEMPLATE/idea.md

@@ -0,0 +1,17 @@
+---
+name: Idea
+about: A proposal worth considering, not planned yet
+labels: idea
+---
+
+## Context
+
+What problem or situation this is about.
+
+## Proposal
+
+What gcw could do about it.
+
+## Open questions
+
+What would have to be decided before it becomes planned work.

gcw-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+Closes #
+
+## What changed
+
+## Why
+
+## Verification
+
+- `uv run pytest`:
+- By hand:

gcw-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pytest:
+    name: pytest (${{ matrix.os }}, Python ${{ matrix.python }})
+    strategy:
+      fail-fast: false
+      # Platform differences and Python-version differences are independent:
+      # the oldest supported Python runs on every OS, the newest on Linux only.
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.11"]
+        include:
+          - os: ubuntu-latest
+            python: "3.13"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync
+      - run: uv run pytest
+
+  # Single required status check for branch protection: green only if every
+  # job above passed. New checks (lint, etc.) are added to `needs`.
+  ci:
+    if: always()
+    needs: [pytest]
+    runs-on: ubuntu-latest
+    steps:
+      - run: test "${{ needs.pytest.result }}" = success

gcw-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+# Publishes gcw to PyPI when a tag vX.Y.Z is pushed (ADR-0025).
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      # The version lives in pyproject.toml; the tag must match it.
+      - name: Check that the tag matches the project version
+        run: |
+          version="$(uv version --short)"
+          if [ "${GITHUB_REF_NAME#v}" != "$version" ]; then
+            echo "::error::tag $GITHUB_REF_NAME does not match version $version in pyproject.toml"
+            exit 1
+          fi
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # Only this job can publish: it builds nothing, gets the OIDC token that
+  # PyPI Trusted Publishing checks, and waits for approval in `pypi`.
+  publish:
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/gcw/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

gcw-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+.venv/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+.coverage
+htmlcov/
+
+CLAUDE.md

gcw-0.1.0/AGENTS.md

@@ -0,0 +1,56 @@
+# AGENTS.md
+
+Instructions for AI agents (Claude Code, Codex, etc.) working in this repository.
+
+## Project
+
+`gcw` ("gcloud web"): a `gh browse`-style CLI that opens Google Cloud services and resources in the browser, taking context from the gcloud configuration and offering instant TAB completion of resource names.
+
+- Open work: GitHub issues (`gh issue list`). A milestone is a release; `enhancement` is planned work, `idea` a proposal, `bug` a defect ([ADR-0021](docs/adr/0021-open-work-in-github-issues.md)).
+- Direction: [docs/plan.md](docs/plan.md). How gcw works: [docs/architecture.md](docs/architecture.md). Docs carry no status: never add checklists or "done" markers to them; progress is visible only in issues, milestones and merged pull requests.
+- Decisions: [docs/adr/](docs/adr/). A new decision is a new ADR plus a row in [docs/adr/README.md](docs/adr/README.md), committed with the code it concerns.
+- `docs/` is committed and written in English ([ADR-0014](docs/adr/0014-docs-in-repo.md)). The only exception is `docs/research.md`, a local Polish notebook excluded via `.git/info/exclude`; never commit it.
+
+## Rules that require a new ADR to break
+
+- **Runtime uses the standard library only.** Third-party packages are allowed in the dev group only (pytest, etc.).
+- **gcw navigates, gcloud operates.** No commands that change the state of cloud resources.
+- **The completion path (`gcw __complete`) never touches the network or spawns subprocesses**; it reads the cache only. Budget: < 100 ms ([ADR-0022](docs/adr/0022-tab-budget-100ms.md)). Do not add slow top-level imports; import lazily inside functions that are not on the completion path.
+- **URL routes are data, not logic.** Adding a service is primarily a registry entry, and every URL template must be verified against the real console.
+- **Do not import gcloud's code.** Read gcloud's files only where an ADR allows it: its INI configuration. Never read its credential files ([ADR-0023](docs/adr/0023-no-token-database-opt-in.md)); tokens come from `gcloud auth print-access-token`.
+
+## Stack and commands
+
+- Python >= 3.11 (`tomllib`), uv, `src/` layout.
+- `uv sync` to set up the environment, `uv run pytest` to run tests, `uv run gcw …` to run the CLI.
+- Tests must not use the network or the real `~/.config/gcloud`. Use a fake `CLOUDSDK_CONFIG` under `tmp_path`.
+
+## Workflow
+
+- **The user reviews every edit and wants to understand it.** For every file change, briefly explain (in Polish, in the chat) what you are changing, why, and how it connects to the rest of the code. Avoid large unexplained changes; split work into steps that can be read and understood one at a time.
+- **Work starts from an issue.** Read it first (`gh issue view N`); its Tasks and Done when are the scope. A pull request that finishes it says `Closes #N` in its description.
+- **Keep the issue in sync with the work.** When a decision changes the scope, propose a ready-to-paste `gh issue edit` that updates its Tasks. Before the pull request, propose ticking the finished tasks; anything done differently from the issue goes into a closing comment on the issue and into the PR description. Work that belongs to another issue (or to none) gets its own task there, or a new issue.
+- **New work becomes an issue, not a note in the docs.** Propose it as a ready-to-paste `gh issue create` command following the templates in `.github/ISSUE_TEMPLATE/` (feature: Context, Plan, Tasks, Done when; idea: Context, Proposal, Open questions).
+- **Docs change together with the code.** A pull request that changes behaviour updates `README.md` and `docs/architecture.md`; one that makes a decision adds an ADR. `docs/plan.md` changes only when the direction changes.
+- **Everything committed is in English**: code, identifiers, docstrings, comments, CLI messages, commit messages, docs, this file. Only the local `docs/research.md` stays in Polish.
+
+## Commits and pull requests
+
+- **Every change goes through a pull request into `master`**; never commit directly to `master`. Work on a branch named `<type>/<short-description>` (e.g. `feat/gcloud-config`).
+- **The user runs git and gh, not the agent.** Never run `git add`, `git commit`, `git push`, branch-switching commands or `gh pr create` yourself. Instead, propose in the chat the ready-to-paste commands together with the commit message and the PR title/description, so the user can adjust them before running.
+- Format: [Conventional Commits](https://www.conventionalcommits.org/), `type: description` or `type(scope): description`.
+  - Types: `feat`, `fix`, `refactor`, `perf`, `test`, `docs`, `build` (packaging, dependencies, uv), `ci`, `chore`.
+  - Scope is optional. Use it only when it adds information: a layer (`cli`, `context`, `cache`, `api`, `web`, `services`) or a GCP service (`run`, `sql`, …). Omit it for cross-cutting changes; never force one.
+  - Description: imperative mood, lowercase, no trailing period, about 72 characters max. Mark breaking changes with `!` (e.g. `feat(cli)!: …`).
+- No AI attribution: do not add `Co-Authored-By` or "Generated with" lines to commit messages or PR descriptions.
+- The PR title uses the same format, because it becomes the commit message on squash merge. The PR description explains what changed and why, and how it was verified.
+
+## ADRs
+
+- A significant decision (a dependency, a data format, user-visible behavior, an exception to the rules above) requires a new `docs/adr/NNNN-short-title.md` based on the [template](docs/adr/template.md).
+- Do not rewrite accepted ADRs. Record a new decision as a new ADR with `Status: Accepted, supersedes NNNN`, and set `Superseded by NNNN` in the old one.
+
+## Conventions
+
+- **English docstrings are mandatory** for every module (what it does and what it is responsible for), class, function and method, including service modules (which GCP service it covers: routes, tabs, where the resource list comes from). Style: a one-line summary; for non-trivial logic, add a description, arguments and the return value.
+- Inline comments only where the code does not speak for itself.

gcw-0.1.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to gcw are recorded here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow [ADR-0025](docs/adr/0025-release-process.md): 0.x while gcw is a prototype, a breaking change bumps the minor version.
+
+## [0.1.0] - 2026-11-06
+
+First release. Console URL templates were checked by hand against the real console, except the resource pages of Cloud Functions and Composer ([#35](https://github.com/terleckimaciej/gcloud-web/issues/35)).
+
+### Added
+
+- Open Google Cloud console pages from the terminal with gcloud's words: `gcw` (project dashboard), `gcw SERVICE`, `gcw SERVICE KIND`, `gcw SERVICE KIND NAME [--tab TAB]`, and `gcw open PATH` for any console path.
+- Resource pages for Cloud Run, Cloud SQL, Cloud Storage, Compute Engine, GKE, Cloud Functions, Secret Manager, Artifact Registry, IAM service accounts, Dataproc and Composer (including its Airflow UI), and start pages of about 50 more services; `gcw services` prints the map.
+- Context from gcloud's configuration: account, project and default regions, with `-p/--project`, `-c/--configuration` and `-l/--location` to override them for one command.
+- A local cache of resource names and locations, filled from each service's read-only REST `list` API and refreshed in the background; `gcw cache list` and `gcw cache refresh`.
+- TAB completion of commands, kinds, resource names and tabs from the cache in bash, zsh and fish: `gcw completion SHELL [--install]`.
+- gcloud command syntax as input: `gcw gcloud GCLOUD_ARGS...`, and an opt-in `gcloud … --web` shell function from `gcw web-flag SHELL [--install]`.
+- `gcw env CONFIGURATION` to use another gcloud configuration in one shell.
+- `-n/--no-browser` to print the URL instead of opening it, and `--no-authuser`.
+- Linux, macOS and Windows; no runtime dependencies besides Python 3.11+ and gcloud.
+
+[0.1.0]: https://github.com/terleckimaciej/gcloud-web/releases/tag/v0.1.0

gcw-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.