gcpath 0.1.0

A CLI utility to manage Google Cloud Platform resource hierarchy paths.

gcpath

gcpath is a CLI utility to manage Google Cloud Platform resource hierarchy paths. It helps you translate between GCP resource names (e.g., folders/12345) and human-readable paths (e.g., //example.com/department/team).

Features

• Recursive Listing: List all folders in your organization as paths.
• Path Resolution: Get the resource name (ID) for a given path.
• Reverse Lookup: Get the path for a given resource name (ID).
• Dual Mode:
  • Cloud Asset API (Default): Fast, bulk loading using GCP Cloud Asset Inventory.
  • Resource Manager API: Iterative loading using standard Resource Manager API (slower, but different permissions).

Quick Start

After installation, ensure you are authenticated with Google Cloud and have the necessary permissions.

# List all resources
gcpath ls

# Find ID of a specific path
gcpath name //example.com/engineering

# Find path of a specific resource ID
gcpath path folders/123456789

Authentication

gcpath uses Google Cloud Application Default Credentials (ADC).

Setup

1. Install gcloud CLI.
2. Authenticate:

   gcloud auth application-default login
   

For service accounts in CI/CD environments:

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json

Usage

List Folders

Recursively list all folders in your organization(s):

gcpath ls

Output:

//example.com/engineering
//example.com/engineering/backend
//example.com/sales
...

You can also filter by organization display name:

gcpath ls "example.com"

Get Resource Name

Get the GCP resource name (e.g., folders/123) from a path:

gcpath name //example.com/engineering/backend
# Output: folders/987654321

To get just the ID:

gcpath name --id //example.com/engineering/backend
# Output: 987654321

Get Path

Get the path from a resource name:

gcpath path folders/987654321
# Output: //example.com/engineering/backend

Tree View

Visualize the hierarchy in a tree format:

gcpath tree

Options:

• -L, --level N: Limit depth of the tree.
• -i, --ids: Include resource IDs in the output.

Modes

By default, gcpath uses the Cloud Asset API which is faster for large hierarchies. To force using the Resource Manager API (iterative), use the -U / --no-use-asset-api flag:

gcpath ls -U

Permissions

Cloud Asset API (Default)

Requires cloudasset.assets.searchAllResources permission on the Organization.

Resource Manager API

Requires resourcemanager.folders.list on the Organization and folders.

Development

Prerequisites: uv (https://github.com/astral-sh/uv).

1. Clone the repository.
2. Install dependencies:

   uv sync
   

3. Run tests:

   uv run pytest
   

License

MIT