Metadata-Version: 2.4
Name: gcpctx
Version: 0.2.0
Summary: Directory-scoped Google Cloud service account impersonation contexts
Author: yu-iskw
License:                                  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.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: tomli-w>=1.0.0
Requires-Dist: typer>=0.12.0
Description-Content-Type: text/markdown

# gcpctx

Directory-scoped Google Cloud service account impersonation contexts for terminals, IDEs, and coding agents.

## What is gcpctx?

`gcpctx` automatically activates an isolated Google Cloud SDK and Application Default Credentials (ADC) environment when you enter a directory with a `.gcpctx.toml` file. Each profile maps to a GCP project and an impersonated service account. Activation exports a dedicated `CLOUDSDK_CONFIG` so your global `~/.config/gcloud` is never mutated.

## Why directory-scoped impersonation?

Developers and coding agents often inherit broad or wrong GCP credentials from the parent shell. `gcpctx` scopes authentication to the repository you are working in, with first-use approval and config-hash invalidation when trust-relevant settings change.

## Installation

Choose one of these options:

| Method                            | Best for                                             |
| --------------------------------- | ---------------------------------------------------- |
| [`uvx`](#run-with-uvx-no-install) | Try without installing, CI one-offs, pinned versions |
| [`pipx`](#pipx)                   | Daily CLI use on your machine                        |
| [From source](#from-source)       | Contributing or unreleased builds                    |

### Run with `uvx` (no install)

[`uvx`](https://docs.astral.sh/uv/guides/tools/) runs `gcpctx` in an ephemeral environment—no global install required.

```bash
# Latest from PyPI (when published)
uvx gcpctx --help

# Pin a version
uvx gcpctx@0.2.0 status

# Run from a local checkout (before publish)
uvx --from /path/to/gcpctx gcpctx --help
```

Typical workflow with `uvx`:

```bash
cd my-repo
uvx gcpctx init-project \
  --project my-dev-project \
  --service-account agent-dev@my-dev-project.iam.gserviceaccount.com

uvx gcpctx approve
eval "$(uvx gcpctx activate --shell zsh)"

uvx gcpctx status
uvx gcpctx doctor
```

Shell hooks installed via `gcpctx init zsh` call `gcpctx` on your `PATH`. After choosing `uvx`, either add a shell alias (`alias gcpctx='uvx gcpctx'`) or install with `pipx` / `uv tool install` for hook integration.

### pipx

```bash
pipx install gcpctx
gcpctx --help
```

### From source

```bash
git clone <repo-url> && cd gcpctx
uv sync
uv run gcpctx --help
# optional: uv tool install -e .
```

## Quick start

```bash
# 1. Create project config
gcpctx init-project --project my-dev-project \
  --service-account agent-dev@my-dev-project.iam.gserviceaccount.com

# 2. Approve and activate (zsh example)
gcpctx approve
eval "$(gcpctx activate --shell zsh)"

# 3. Verify
gcpctx status
gcloud config list
```

## `.gcpctx.toml` example

```toml
version = 1
default_profile = "dev"

[profiles.dev]
project = "my-dev-project"
service_account = "agent-dev@my-dev-project.iam.gserviceaccount.com"
quota_project = "my-billing-project"
region = "asia-northeast1"
```

## Shell integration

```bash
gcpctx init zsh   # or: gcpctx init bash
exec $SHELL       # reload shell
```

The hook runs `gcpctx hook eval` on every directory change. **Stdout is shell code only**; diagnostics go to stderr.

Manual activation without hooks:

```bash
eval "$(gcpctx activate --shell zsh)"
eval "$(gcpctx deactivate --shell zsh)"  # restore prior env
```

Switch profile (after `gcpctx init` installs the wrapper):

```bash
gcpctx-use prod-readonly
```

## IDE usage (VS Code, Cursor, JetBrains)

Integrated terminals **inherit the parent shell environment**. Subprocesses started by the IDE (build tasks, debuggers, test runners) see the same `CLOUDSDK_CONFIG`, ADC, and `GCPCTX_*` variables as your shell.

### Recommended setup

1. Install shell hooks (`gcpctx init zsh`) or manually `eval "$(gcpctx activate --shell zsh)"` in your login shell.
2. Open the IDE **from that shell** (`cursor .`, `code .`) so new integrated terminals start activated.
3. Confirm with `gcpctx status` in an integrated terminal.

### Verify isolation

```bash
gcpctx status
gcpctx doctor
gcpctx doctor --json   # machine-readable for scripts
```

Doctor checks that `CLOUDSDK_CONFIG` lives under `~/.cache/gcpctx/contexts/`, gcloud project/impersonation match your profile, and ADC is initialized.

**`GOOGLE_APPLICATION_CREDENTIALS`**

In hook mode, `GOOGLE_APPLICATION_CREDENTIALS` is unset while active (previous value restored on deactivate) so ADC impersonation is not overridden. If you must keep a key file in non-interactive sessions, pass `--allow-google-application-credentials` to `activate`.

## Coding agents (Cursor, Claude Code, Codex, Copilot)

Agents run in terminals or sandboxes that inherit environment variables. Use either **shell activation** (whole session) or **`gcpctx run`** (one process only).

### Process-scoped launch (recommended for agents)

Run a command with per-project credentials **without** changing your parent shell:

```bash
gcpctx approve
gcpctx run -- claude
uvx gcpctx run -- codex ...
gcpctx run --profile dev -- gcloud storage ls
```

- Requires `.gcpctx.toml` in the current directory tree (exit 2 if missing).
- Pre-approve for non-interactive terminals (`gcpctx approve`).
- `GOOGLE_APPLICATION_CREDENTIALS` is unset in the child by default (same as hook mode).
- Access tokens are short-lived; client libraries refresh ADC automatically (no gcpctx supervisor).

### Shell activation (whole session)

1. Add `.gcpctx.toml` to the repo (`gcpctx init-project`).
2. **Approve once** interactively, or pre-approve for automation:

   ```bash
   gcpctx approve   # remembered approval for this directory/profile
   ```

3. Activate in the shell that launches the agent:

   ```bash
   eval "$(gcpctx activate --shell zsh)"
   ```

4. Agents and their subprocesses inherit isolated credentials.

### Non-interactive / fail-closed

Without a matching approval, `gcpctx activate` exits with code **3** in non-interactive mode (typical agent terminals). Pre-run `gcpctx approve` in CI or document that users must activate interactively once.

### Agent-friendly diagnostics

```bash
gcpctx doctor --json
gcpctx status --json
```

Parse JSON for `active`, `cloudsdk_config`, `approval`, and per-check status from doctor.

**When `GOOGLE_APPLICATION_CREDENTIALS` is required**

Some tools insist on a key file path. Use `--allow-google-application-credentials` only when necessary; prefer impersonated ADC otherwise.

## Security model (v0.2)

- **POSIX only** — Windows is unsupported; the CLI fails closed until ACL checks land.
- First-use approval with remember + **TTL** (default 30 days); schema v2 binds **gcloud path and fingerprint**
- Config SHA-256 binding invalidates approval when project, service account, or config changes
- **Immutable project identity** — `CLOUDSDK_CORE_PROJECT` always matches `profile.project` (cannot set via `env`)
- Isolated `CLOUDSDK_CONFIG` under `~/.cache/gcpctx/contexts/`
- Atomic, locked, symlink-safe writes for approvals and context state (`0600`/`0700`)
- gcloud binary trust validation (repo-local shadowing, world-writable parents, optional allowlist)
- Service account impersonation only (no long-lived key files in repo config)
- `GOOGLE_APPLICATION_CREDENTIALS` unset by default in hook mode (restored on deactivate)
- Optional **`policy.toml`** for org-style allowlists and strict mode
- **`gcpctx doctor --strict --json`** for CI/agent compliance gates
- Append-only **`audit.jsonl`** for security events (no credential material)

See [SECURITY.md](SECURITY.md) and [Architecture decision records](docs/adr/) (ADR-0003 through ADR-0009).

### Upgrading from v0.1

- Remove any `[profiles.*.env] CLOUDSDK_CORE_PROJECT` entries — use `profile.project` instead.
- Service account emails must use the same GCP project as `profile.project` (e.g. `agent@my-dev-project.iam.gserviceaccount.com` for `project = "my-dev-project"`). Cross-project impersonation is not supported in v0.2.
- Re-run `gcpctx approve` after upgrade (approval schema v2 adds gcloud binding and expiry).
- Pin gcloud per project if needed: add `gcloud_path` to `.gcpctx.toml` or run `gcpctx config set-gcloud-path "$(which gcloud)"` in the repo (optional; pinning overrides PATH — run `gcpctx config unset-gcloud-path` if you move or upgrade gcloud)

### Policy file (optional)

`~/.config/gcpctx/policy.toml` or `$GCPCTX_POLICY_PATH`:

```toml
version = 1
[policy]
mode = "strict"
approval_ttl_days = 30
require_initialized_adc_for_hook = true
[allow]
projects = ["dev-*"]
[gcloud]
allowed_paths = ["/opt/google-cloud-sdk/bin/gcloud"]
```

### Strict doctor

```bash
gcpctx doctor --strict --json
```

Non-zero exit when isolation, approval, ADC, IAM impersonation, or filesystem posture is unsafe.

## Troubleshooting

| Symptom                         | Fix                                                                                |
| ------------------------------- | ---------------------------------------------------------------------------------- |
| `approval required` in CI/agent | Run `gcpctx approve` once, or activate interactively                               |
| Wrong project                   | `gcpctx status`; check `.gcpctx.toml`                                              |
| Stale credentials               | `gcpctx refresh`, `gcpctx reset`, or `gcpctx clean` (then `gcpctx clean --reinit`) |
| Corrupt isolated ADC / clutter  | `gcpctx clean` (project); `gcpctx clean --all-contexts` (all cache)                |
| Reset remembered approvals      | `gcpctx clean --approvals` or `gcpctx revoke`                                      |
| `gcloud` not found              | Install [Google Cloud SDK](https://cloud.google.com/sdk)                           |
| ADC issues                      | `gcpctx doctor`                                                                    |
| IDE terminal not activated      | Activate in parent shell before launching IDE, or use shell hooks                  |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for developer setup, tests, and architecture notes.
