MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-06-17 14:57:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(ux): formalize gbuild alias setup and reminders

Browse Source
This commit is contained in:
Keith Guerin
2026-03-27 21:11:55 -07:00
parent 659a05d4eb
commit 851aff70e6
3 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/extensions/gemini-cli-ux/GEMINI.md
+5 -2
View File
@@ -32,8 +32,11 @@ underlying "rigor."
`preflight` inside `/ux-pr`), explain it as a benefit to the user: _"I'm
running the full preflight now to ensure everything is correct for review."_
4. **Build Reminders**: Whenever you finish implementing a feature, fix, or
update, you MUST remind the user to test their changes by running:
`npm run bundle; node bundle/gemini.js`.
update, you MUST remind the user to test their changes by running their
`gbuild` alias. If the user does not have this alias configured, you MUST
proactively offer to run
`echo "alias gbuild='npm run bundle && node bundle/gemini.js'" >> ~/.zshrc`
(or `.bash_profile`) to set it up for them.
5. **PR Output**: After successfully creating or updating a PR, you MUST
provide the GitHub PR link, the linked Issue link, and the `npx` command to
test the PR branch (e.g., `npx @google/gemini-cli@pr-<number>`).
packages/extensions/gemini-cli-ux/WELCOME.md
+12 -7
View File
@@ -62,17 +62,22 @@ fails CI, run this to trigger the **`ux-git-skill`** submission protocol:
### **⚡️ Quick Start: Build & Run**
To see your changes in action, use the new high-speed bundling process. This is
significantly faster than the old `npm run build-and-start` method:
To see your changes in action, use the new high-speed bundling process. We
highly recommend setting up the `gbuild` alias in your shell profile (`~/.zshrc`
or `~/.bash_profile`):
```bash
# 1. Bundle your changes (FAST)
npm run bundle
# 2. Run your local build
node bundle/gemini.js
alias gbuild='npm run bundle && node bundle/gemini.js'
```
Once set up, anytime you want to build and run your local branch, just type:
```bash
gbuild
```
_(You can ask me to set this alias up for you if you haven't already!)_
---
**Ready to build?** Start with `/ux-new-feature` and tell me what's on your
packages/extensions/gemini-cli-ux/skills/ux-git-workflow/SKILL.md
+1 -1
View File
@@ -27,7 +27,7 @@ When the user asks to "start a new task" or "create a branch":
1. Identify the base directory (the parent of `main/`).
2. Use `git worktree add ../<branch-name> -b <branch-name>` from within `main/`.
3. **Mandatory Prep**: Run `npm install` inside the new worktree directory to ensure all dependencies are resolved.
4. **User Handoff & Education**: Instruct the user to move into the new directory, reload their session, and test their branch using the new fast build method: `npm run bundle; node bundle/gemini.js` (which replaces the slower `npm run build-and-start`).
4. **User Handoff & Education**: Instruct the user to move into the new directory, reload their session, and test their branch using the fast build alias: `gbuild` (which maps to `npm run bundle && node bundle/gemini.js`). If they don't have this alias configured, proactively offer to set it up in their `~/.zshrc` or `~/.bash_profile`.
#### 2. Checking out a PR (Semantic Naming)
When the user asks to "check out PR #123":