ggsrun is an enterprise-grade CLI application and Model Context Protocol (MCP) Server designed to relentlessly orchestrate Google Drive I/O operations and statefully execute Google Apps Script (GAS) natively from your local terminal or via autonomous Large Language Model (LLM) agents.
Built on Go 1.26.4+, ggsrun transitions legacy single-threaded processing into a state-of-the-art, channel-based concurrent streaming architecture. It delivers maximum network throughput, native Shared Drives (Omni-Drive) support, advanced MIME resolution, resilient self-healing retries, and a native Security Sandbox to restrict Google Workspace APIs during autonomous executions.
To make onboarding, development, and advanced operations as seamless as possible, our documentation is fully modularized. Navigate directly to your area of interest:
| Guide / Manual | Description | Link |
|---|---|---|
| π Setup & Onboarding Guide | Step-by-step instructions to configure GCP, generate OAuth2 client secrets, link Google Apps Script, and deploy gateway endpoints. | Setup Guide |
| π Command Reference Manual | In-depth breakdown of all 15+ subcommands (e.g. exe1, exe2, download, upload), recipes, and Mermaid architectural diagrams. |
Command Reference |
| π‘οΈ Security Sandbox Guide | Explains the memory-based wrapper injection, whitelist configuration schemas (sandbox_config.json), and security validation scenarios. |
Sandbox Guide |
| π Stateful Execution Lifecycle | Deep-dive explanation of the backup, sandboxing, upload, execution, and resilient rollback phases of the exe1 command. |
Execution Lifecycle |
| π€ MCP Server Guide | Configuration to run ggsrun as an autonomous tool provider in AI environments (like Claude Desktop or Antigravity), schemas, and scenarios. |
MCP Server Guide |
| π» Interactive TUI Filer Guide | All keyboard shortcuts, search highlighter rules, clipboard integration, and history for the split-screen Japanese PC-98 Filer Mode (ggsrun fd). |
TUI Filer Guide |
| π§ͺ Local Development & Testing | Detailed guide for configuring environment variables (.env), understanding CLI/TUI mock tests, and running automated test suites. |
Development Guide |
| π¬ Manual Integration Tests Suite | Guided verification commands to manually test authorization, sandbox policies, tool schemas, and local file operations. | Manual Tests Suite |
| π Detailed User Manual | Comprehensive manual detailing all commands, advanced options, custom editor integrations (Sublime Text), and legacy parameters. | Detailed Manual |
| π Version Update History | Chronological record of all updates, bug fixes, features, and refactoring milestones from v1.0.0 to the latest release. | Update History |
- Terminal GAS Development: Develop Google Apps Script using your favorite local text editors and terminals seamlessly.
- Dynamic Script Execution: Execute GAS directly by injecting values, arguments, and payloads into your scripts dynamically.
- Massively Parallel Downloads: Pull files and folders concurrently from Google Drive with stunning progress visualizations.
- Massively Parallel Uploads: Push folders recursively with native Resumable upload wrappers and automated chunks handling.
- Flexible Project Formats: Download standalone scripts or container-bound projects flawlessly.
- Recursive Folder Structuring: Map local directories to Google Drive folders recursively, retaining absolute directory trees.
- Multi-Format Container Synced Uploads: Upload script files and instantly provision standalone scripts OR container-bound scripts.
- Permissions Orchestration: Inspect, list, and manage file and folder sharing permissions across your entire Drive.
- Advanced Metadata Search: Query your Google Drive utilizing Google Drive API v3 query syntax and local filename Regular Expressions (Regex).
- Flexible Authentication: Natively supports both robust browser loopback OAuth2 and secure Service Accounts.
- Security Sandboxing: Officially integrates with the Antigravity CLI via an embedded in-memory security sandbox wrapper (
--sandbox) to guard Workspace resources. - Self-Healing Project Recovery: Restore the remote GAS project to a clean initial state at any time with a single command (
ggsrun recover).
Legacy single-threaded processing has been completely replaced. ggsrun implements a channel-based worker pool built on golang.org/x/sync/errgroup to maximize network throughput on massive folder hierarchies.
- Learn more in the Command Reference Manual.
The v5 engine forces supportsAllDrives=true and includeItemsFromAllDrives=true across all Google Drive API permutations, allowing enterprise Shared Drives to be mapped and managed seamlessly.
- Learn more in the Command Reference Manual.
The extraction logic dynamically categorizes Google Workspace entities. Downloader rules bypass the standard Drive API for GAS files, automatically routing to the Apps Script API to download scripts natively as structured JSON or packaged ZIP archives.
- Learn more in the Command Reference Manual.
The v5 execution and transfer phase is strictly non-blocking. Google API Rate Limits (HTTP 429) and Server Errors (5xx) trigger an exponential backoff sequence per-worker, ensuring resilient self-healing.
- Learn more in the Command Reference Manual.
Running ggsrun mcp transforms the application into an autonomous JSON-RPC background server via standard I/O, allowing Large Language Model (LLM) agents to search, transfer, and execute scripts safely.
- Learn more in the MCP Server Manual.
Requires Go 1.26.4 or higher installed. Compile and install the binary natively:
$ go install github.com/tanaikech/ggsrun@latestAlternatively, download the pre-compiled binary matching your CPU architecture and operating system from the Official Releases Page:
- macOS (Darwin):
ggsrun_darwin_amd64(Intel) orggsrun_darwin_arm64(Apple Silicon M1/M2/M3) - Linux:
ggsrun_linux_amd64(or matching ARM, 32-bit, or MIPS variants) - Windows:
ggsrun_windows_amd64.exe(or 32-bit, ARM variants)
Once you have downloaded or compiled ggsrun, verify that the binary is functional inside your terminal:
Run the help display command to verify the binary executes and lists available options:
$ ggsrun --helpBefore running any diagnostics or script execution commands, you must configure your Google Cloud credentials and authorize the local application.
Please follow the detailed, step-by-step instructions in the Setup & Onboarding Guide to:
- Obtain and load your GCP OAuth
client_secret.jsoncredentials. - Link your Google Cloud project to your Google Apps Script project.
- Automatically deploy and secure the execution gateway.
Once you have completed the onboarding process, verify API connectivity and loopback token health by running:
$ ggsrun statusYou can easily integrate ggsrun into the Antigravity CLI (agy) as a plugin. Installing this plugin automatically registers the ggsrun MCP server and installs the dedicated Apps Script development Agent Skill (skills/gas-execution/SKILL.md).
Run the following command inside your terminal:
$ agy plugin install https://github.com/tanaikech/ggsrun
# or
$ agy plugin install https://github.com/tanaikech/ggsrun.gitTo uninstall the plugin at any time:
$ agy plugin uninstall ggsrun-pluginThe plugin is structured as follows (excluding legacy Agent Hooks, which are now natively handled by the ggsrun core binary):
ggsrun/
βββ plugin.json # Plugin metadata config for Antigravity CLI
βββ mcp_config.json # MCP server definitions (ggsrun-mcp, workspace-developer)
βββ skills/
βββ gas-execution/
βββ SKILL.md # AI agent guidelines for GAS development and execution
For general Q&A, standard Google API errors, and runtime limits, please refer to the detailed Legacy Q&A Guide.
For setup, Web App redirects, headless authentications, and 404s, please consult the Setup Guide Troubleshooting Section.
- License: MIT License
- Author: Tanaike (Contact: tanaike@hotmail.com)
For advanced enterprise integrations, custom architectural consultations, or security audits.
