Skip to content

Commit 4f09e98

Browse files
committed
docs: synchronize human knowledge vector with cli, iac, and mcp matrix
1 parent 34cfa45 commit 4f09e98

2 files changed

Lines changed: 43 additions & 2 deletions

File tree

docs/DEVELOPER_GUIDE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,20 @@ GERP solves this with **Temporal Workflows**. The `pipeline` handles transaction
2626

2727
## 4. The GraphQL BFF (`cmd/gateway`)
2828
The Backend-For-Frontend receives a universal, deeply nested query from our UIs. When a client requests an `InventoryLot` and its associated `Warehouse`, the Gateway fetches the `scm.InventoryLot`, notices the `WarehouseID` pointer, mathematically fans out the query to the isolated `eam.Service`, and stitches the object graph back together dynamically using `gqlgen` resolvers.
29+
30+
## 5. The CLI Control Plane (`cmd/gerp`)
31+
The `gerp` binary is the native operator terminal giving system administrators direct, low-latency control and query capabilities into the core Spanner domains and Temporal execution queues using `spf13/cobra` (routing) and `spf13/viper` (configuration).
32+
33+
- **Config Bound:** The binary dynamically binds to `.gerp.yaml` in the user's home directory across different shell environments or relies on `GERP_` prefixed environment variables.
34+
- By bypassing the BFF using commands like `gerp audit view`, the CLI securely isolates direct native Spanner telemetry for compliance operations.
35+
36+
## 6. Infrastructure & Deployment (`build/`, `deploy/`)
37+
GERP utilizes mathematically reproducible cloud infrastructure and secure container limits:
38+
- **Docker Packaging (`build/docker/`):** Both `cmd/gateway` and `cmd/worker` exist natively as multi-stage Alpine images optimized for scalable deployment pods.
39+
- **Terraform (`deploy/terraform/`):** GCP-specific HashiCorp constraints physicalizing the raw Cloud Spanner limits (`google_spanner_instance`, `google_spanner_database`) absent rigid DDL schema mappings.
40+
- **Ansible (`deploy/ansible/`):** Orchestrates the deployment configuration variables on the executing hardware targeting Docker container lifecycles.
41+
42+
## 7. The AI Brain Interface (MCP)
43+
GERP exposes FAANG-grade capabilities autonomously to outside LLMs via standard JSON-RPC STDIO built off the Model Context Protocol.
44+
45+
The `cmd/mcp` Server binds to AI agents running on Cursor IDE, Claude Desktop, or centralized orchestration engines via `.cursor/mcp.json`. Agents inherently use the physical tools (`gerp_status`, `gerp_create_order`, `gerp_audit_view`) to mechanically command the Spanner databases and trigger automated Temporal subroutines strictly adhering to the `internal/cli` environmental scope bindings.

docs/gerp.1.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,37 @@
11
GERP(1) GERP Matrix Man Page GERP(1)
22

33
NAME
4-
gerp - Google ERP Master Control Plane
4+
gerp - Google ERP Master Control Plane & Native Operator CLI
55

66
SYNOPSIS
77
make [COMMAND]
8+
gerp [COMMAND] [ARGS...]
89

910
DESCRIPTION
1011
The GERP control plane utilizes Makefile targets to orchestrate a distributed, 7-domain ERP
1112
matrix structurally bound by Temporal Sagas and isolated Spanner data layers.
13+
14+
The compiled `gerp` native CLI allows system administrators and AI Autonomous Agents to
15+
mechanically route direct queries against the Spanner telemetry or asynchronously fire
16+
complex Temporal execution traces.
1217

1318
ARCHITECTURE
1419
The physical runtimes consist of:
1520
- Cloud Spanner Emulator (Local instance binding all 7 domains natively).
1621
- Temporal Server (Local instance managing `GERP_GLOBAL_QUEUE`).
1722
- Go GraphQL Gateway (Port 8080: Binds the BFF execution).
1823
- Go Temporal Worker (Background: Listens for Saga dispatches).
24+
- Go MCP Server (STDIO: Links external Model Context Protocol systems).
1925

20-
COMMANDS
26+
CONFIGURATION
27+
The `gerp` CLI relies natively on a `.gerp.yaml` configuration profile mapped to the
28+
user's local `$HOME` directory or explicitly bound via the following environment variables:
29+
30+
GERP_GRAPHQL_ENDPOINT Target API Gateway (Default: http://localhost:8080/query)
31+
GERP_TEMPORAL_HOST Temporal Control Queue (Default: localhost:7233)
32+
GERP_SPANNER_DB Sovereign Storage Domain Bounds
33+
34+
MAKE COMMANDS
2135
make up
2236
Boot the local Docker infrastructure encompassing Spanner, Temporal, and associated matrix layers.
2337

@@ -33,5 +47,15 @@ COMMANDS
3347
make generate
3448
Regenerate the physical Go bindings for the unified GraphQL API.
3549

50+
GERP NATIVE COMMANDS
51+
gerp status
52+
Pings the GERP matrix execution limits and strictly formats the current operational bounds for the sysadmin.
53+
54+
gerp orders create
55+
Triggers the Global Fulfillment Saga via GraphQL. Safely executing cross-domain mutations across SCM and Finance.
56+
57+
gerp audit view [target_record_id]
58+
Bypasses the API Gateway to directly query Spanner ComplianceAudits locally. Deep inspection specifically formulated for Legal operations.
59+
3660
SEE ALSO
3761
docker-compose(1), temporal(1), gcloud-spanner(1)

0 commit comments

Comments
 (0)