Skip to content

Commit bff1f08

Browse files
aklofasclaude
andcommitted
docs: cross-agent install and usage guidance
- README.md: Gemini CLI install block - install-guidance.md: refresh Gemini section — `gemini skills link` now shipped (#18294), slash commands, tier precedence, npm-based upgrade - CONTRIBUTING.md: Gemini CLI link+reload hints alongside the Claude validate step - GEMINI.md: project-specific agent guidance auto-loaded by Gemini CLI Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 4966c17 commit bff1f08

4 files changed

Lines changed: 48 additions & 28 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,11 @@ description: One paragraph describing what this skill does and when to use it. I
134134

135135
2. Add any scripts to `skills/<name>/scripts/`
136136
3. Add a symlink in `.agents/skills/`: `ln -s ../../skills/<name> .agents/skills/<name>`
137+
* **Gemini CLI:** Use `gemini skills link . --scope workspace` to link the whole repo.
137138
4. Update the manual install lists in `README.md` (both Claude Code and Codex sections)
138-
5. Validate: `claude plugin validate .`
139+
5. Validate:
140+
* **Claude Code:** `claude plugin validate .`
141+
* **Gemini CLI:** Run `/skills reload` in an active session to verify discovery.
139142

140143
Keep SKILL.md language agent-neutral — use "the agent" instead of "Claude", "use web search" instead of "WebSearch", etc.
141144

GEMINI.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# kicad-happy
22

3-
AI-powered electronics design review skills for KiCad 5-10. This repo provides structured Python analysis scripts and skill definitions for AI coding agents.
3+
AI-powered electronics design review skills for KiCad 5-10. This document is auto-loaded into the Gemini CLI context and carries project-specific guidance for agents working in this repo.
44

5-
## Skills
5+
## Agent guidelines
6+
7+
1. **Skill activation**: invoke `activate_skill` before running the Python scripts in this repo. Each skill's `SKILL.md` carries procedural guidance, triggers, and constraints that aren't in the main system prompt.
8+
2. **Context efficiency**:
9+
- **Search first**: use `grep_search` to find points of interest in `.kicad_sch` and `.kicad_pcb` files — they routinely exceed 10,000 lines.
10+
- **Targeted reads**: avoid reading whole schematic/PCB files. Use line numbers from `grep_search` for surgical `read_file` calls.
11+
- **Trust analyzer output**: the Python analysis scripts are the source of truth for design data. Don't guess circuit behavior from raw S-expressions when a detector already covers it.
12+
3. **Validation**: a change isn't done until the relevant `analyze_*.py` script has been re-run and produces no new warnings or regressions.
613

7-
Each skill is defined in `skills/<name>/SKILL.md` with usage instructions and triggers. Read the relevant SKILL.md before using a skill.
14+
## Skills
815

916
| Skill | Purpose |
1017
|-------|---------|
@@ -39,7 +46,7 @@ python3 skills/emc/scripts/analyze_emc.py --schematic sch.json --pcb pcb.json
3946
python3 skills/kicad/scripts/analyze_gerbers.py <gerber_dir>/
4047
```
4148

42-
All scripts are zero-dependency (Python 3.8+ stdlib only). No pip install needed.
49+
All scripts are zero-dependency (Python 3.10+ stdlib only). No `pip install` needed.
4350

4451
## Code structure
4552

@@ -55,7 +62,7 @@ All scripts are zero-dependency (Python 3.8+ stdlib only). No pip install needed
5562
- `skills/kicad/references/` — 19 deep methodology guides
5663
- `skills/datasheets/` — Extraction pipeline with 4 reference guides (schema, field-extraction, scoring, consumer API)
5764

58-
## Key docs
65+
## Documentation reference
5966

6067
- `CONTRIBUTING.md` — How detectors work, how to add skills, test harness usage
6168
- `VALIDATION.md` — Test methodology and corpus statistics

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,13 +117,19 @@ Use Codex's built-in skill installer first:
117117
118118
If you prefer a manual install, install the skills into `~/.codex/skills/`.
119119
120-
Clone the repo:
120+
**Google Gemini CLI:**
121+
122+
Install the skills globally for your user:
121123
122124
```bash
123-
git clone https://github.com/aklofas/kicad-happy.git
125+
gemini skills install https://github.com/aklofas/kicad-happy.git
124126
```
125127
126-
After installing new skills, restart Codex if they do not appear immediately.
128+
Or install them to your current workspace only:
129+
130+
```bash
131+
gemini skills install https://github.com/aklofas/kicad-happy.git --scope workspace
132+
```
127133

128134
<details>
129135
<summary><strong>Manual install & other platforms</strong></summary>

install-guidance.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -273,37 +273,43 @@ Or `git pull` for symlink installs.
273273

274274
### Install
275275

276+
Install the skills globally to `~/.gemini/skills/`:
277+
276278
```bash
277279
gemini skills install https://github.com/aklofas/kicad-happy.git
278280
```
279281

280-
This installs to `~/.gemini/skills/` (user scope) by default. For repo-local:
282+
For repo-local (workspace) installation:
281283

282284
```bash
283285
gemini skills install https://github.com/aklofas/kicad-happy.git --scope workspace
284286
```
285287

286288
### Install (manual symlinks)
287289

288-
Gemini CLI discovers skills from `~/.gemini/skills/` or `~/.agents/skills/`:
290+
Gemini CLI discovers skills from `~/.gemini/skills/` or `~/.agents/skills/`. The `gemini skills link` command is the standard way to set up a development environment:
289291

290292
```bash
291293
git clone https://github.com/aklofas/kicad-happy.git
292294
cd kicad-happy
293-
mkdir -p ~/.gemini/skills
294-
for skill in kicad spice emc datasheets bom digikey mouser lcsc element14 jlcpcb pcbway kidoc; do
295-
ln -sf "$(pwd)/skills/$skill" ~/.gemini/skills/$skill
296-
done
295+
gemini skills link .
297296
```
298297

299-
### Management
298+
### Management & Interactive Mode
300299

301-
```bash
302-
gemini skills list
303-
gemini skills enable <name>
304-
gemini skills disable <name>
305-
gemini skills uninstall <name>
306-
```
300+
You can manage skills from the terminal or interactively using slash commands:
301+
302+
* **`gemini skills list`** / **`/skills list`**: List all discovered skills.
303+
* **`gemini skills enable/disable <name>`** / **`/skills enable/disable <name>`**: Toggle a skill.
304+
* **`/skills reload`**: Refresh the skill registry (use after editing `SKILL.md` or scripts).
305+
* **`/skills link <path>`**: Link local skills during an active session.
306+
307+
### Skill Tier Precedence
308+
309+
Gemini CLI discovers skills in three tiers with the following precedence:
310+
1. **Workspace Tier**: `.gemini/skills/` or `.agents/skills/` in the project root.
311+
2. **User Tier**: `~/.gemini/skills/` or `~/.agents/skills/`.
312+
3. **Extension Tier**: Bundled within installed extensions.
307313

308314
### Upgrade
309315

@@ -312,15 +318,13 @@ gemini skills uninstall kicad-happy
312318
gemini skills install https://github.com/aklofas/kicad-happy.git
313319
```
314320

315-
Or `git pull` for symlink installs.
321+
For linked installs, simply `git pull` in the cloned repository and run `/skills reload`.
316322

317323
### Known issues
318324

319-
- Skills support is relatively new (v0.23.0+). The `gemini skills` commands are
320-
still evolving.
321-
- `gemini skills link` (symlink-based install, like `gemini extensions link`) is
322-
an open feature request
323-
([google-gemini/gemini-cli#18294](https://github.com/google-gemini/gemini-cli/issues/18294)).
325+
- Skill discovery is most stable in v0.25.0+. Ensure your CLI is up to date by running:
326+
`npm install -g @google/gemini-cli@latest`
327+
- Large skill directories may take a moment to index during initial startup.
324328

325329
### Gemini-specific notes
326330

0 commit comments

Comments
 (0)