From ed328e54776f7df69e473a4c1fd368c9ce3ed4c3 Mon Sep 17 00:00:00 2001 From: Eng Lengjai Date: Wed, 25 Mar 2026 03:46:53 -0700 Subject: [PATCH] perf: shallow clone for faster install (~30s as advertised) Summary Full git clone was taking ~5 minutes due to full history download, making the "30 second install" claim inaccurate. All 4 clone commands in README.md now use --single-branch --depth 1 for a fast shallow clone. Added a contributor note for power users who need full history. Test plan - [ ] Verify all 4 clone commands have --single-branch --depth 1 - [ ] Contributor note visible between Step 2 and Codex section - [ ] No other README content changed --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd81d78c..eaadb755 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Fork it. Improve it. Make it yours. And if you want to hate on free open source Open Claude Code and paste this. Claude does the rest. -> Install gstack: run **`git clone https://github.com/garrytan/gstack.git ~/.claude/skills/gstack && cd ~/.claude/skills/gstack && ./setup`** then add a "gstack" section to CLAUDE.md that says to use the /browse skill from gstack for all web browsing, never use mcp\_\_claude-in-chrome\_\_\* tools, and lists the available skills: /office-hours, /plan-ceo-review, /plan-eng-review, /plan-design-review, /design-consultation, /review, /ship, /land-and-deploy, /canary, /benchmark, /browse, /qa, /qa-only, /design-review, /setup-browser-cookies, /setup-deploy, /retro, /investigate, /document-release, /codex, /cso, /autoplan, /careful, /freeze, /guard, /unfreeze, /gstack-upgrade. Then ask the user if they also want to add gstack to the current project so teammates get it. +> Install gstack: run **`git clone --single-branch --depth 1 https://github.com/garrytan/gstack.git ~/.claude/skills/gstack && cd ~/.claude/skills/gstack && ./setup`** then add a "gstack" section to CLAUDE.md that says to use the /browse skill from gstack for all web browsing, never use mcp\_\_claude-in-chrome\_\_\* tools, and lists the available skills: /office-hours, /plan-ceo-review, /plan-eng-review, /plan-design-review, /design-consultation, /review, /ship, /land-and-deploy, /canary, /benchmark, /browse, /qa, /qa-only, /design-review, /setup-browser-cookies, /setup-deploy, /retro, /investigate, /document-release, /codex, /cso, /autoplan, /careful, /freeze, /guard, /unfreeze, /gstack-upgrade. Then ask the user if they also want to add gstack to the current project so teammates get it. ### Step 2: Add to your repo so teammates get it (optional) @@ -54,6 +54,11 @@ Open Claude Code and paste this. Claude does the rest. Real files get committed to your repo (not a submodule), so `git clone` just works. Everything lives inside `.claude/`. Nothing touches your PATH or runs in the background. +> **Contributing or need full history?** The commands above use `--depth 1` for a fast install. If you plan to contribute or need full git history, do a full clone instead: +> ```bash +> git clone https://github.com/garrytan/gstack.git ~/.claude/skills/gstack +> ``` + ### Codex, Gemini CLI, or Cursor gstack works on any agent that supports the [SKILL.md standard](https://github.com/anthropics/claude-code). Skills live in `.agents/skills/` and are discovered automatically. @@ -61,7 +66,7 @@ gstack works on any agent that supports the [SKILL.md standard](https://github.c Install to one repo: ```bash -git clone https://github.com/garrytan/gstack.git .agents/skills/gstack +git clone --single-branch --depth 1 https://github.com/garrytan/gstack.git .agents/skills/gstack cd .agents/skills/gstack && ./setup --host codex ``` @@ -70,7 +75,7 @@ When setup runs from `.agents/skills/gstack`, it installs the generated Codex sk Install once for your user account: ```bash -git clone https://github.com/garrytan/gstack.git ~/gstack +git clone --single-branch --depth 1 https://github.com/garrytan/gstack.git ~/gstack cd ~/gstack && ./setup --host codex ``` @@ -81,7 +86,7 @@ discovery from the source repo checkout. Or let setup auto-detect which agents you have installed: ```bash -git clone https://github.com/garrytan/gstack.git ~/gstack +git clone --single-branch --depth 1 https://github.com/garrytan/gstack.git ~/gstack cd ~/gstack && ./setup --host auto ```