Skip to content

Commit e964096

Browse files
committed
docs: Hermes-first README and hero asset slot
Punchy drop-in skill positioning, badges, install/quickstart, and docs/assets path ready for Toni-style hero art.
1 parent 9835e97 commit e964096

2 files changed

Lines changed: 92 additions & 40 deletions

File tree

README.md

Lines changed: 85 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,37 @@
11
# scripts-bash
22

3-
**A [Hermes Agent](https://github.com/NousResearch/hermes-agent) skill** for writing excellent long-lived bash installer and manager scripts.
3+
[![validate](https://github.com/Unix-Dev-Ops/scripts-bash/actions/workflows/validate.yml/badge.svg)](https://github.com/Unix-Dev-Ops/scripts-bash/actions/workflows/validate.yml)
4+
[![Hermes Skill](https://img.shields.io/badge/Hermes-Skill-7c3aed?style=flat-square)](https://github.com/NousResearch/hermes-agent)
5+
[![Category](https://img.shields.io/badge/category-software--development-0ea5e9?style=flat-square)](#install)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](LICENSE)
47

5-
Drop it into Hermes. Load the skill. Copy the template. Ship installers that look and behave like a real ops toolkit - not vibecoded one-offs.
8+
> **MCP gives Hermes tools. Skills give Hermes judgment. `scripts-bash` gives Hermes a standard for the bash that runs your stack.**
69
7-
| | |
8-
|--|--|
9-
| **For** | [Hermes Agent](https://hermes-agent.nousresearch.com/) by Nous Research |
10-
| **Category** | `software-development` (bash / installers / automation) |
11-
| **Author** | [Vituvo](https://github.com/Unix-Dev-Ops) (`Unix-Dev-Ops`) |
12-
| **License** | MIT |
13-
| **Install path** | `~/.hermes/skills/software-development/scripts-bash/` |
10+
Drop-in [Hermes Agent](https://github.com/NousResearch/hermes-agent) skill for **long-lived bash installer and manager scripts** - the kind you keep for years, not throwaway one-liners.
1411

15-
> This repository is **only** the Hermes skill package. It is not a Kaggle project, not a Google ADK app, and not a dump of private host installers.
12+
<!-- Hero: add docs/assets/scripts-bash-hero.png (Toni-style cyberpunk Hermes + terminal HUD) then uncomment:
13+
![scripts-bash hero - Hermes-grade bash installers](docs/assets/scripts-bash-hero.png)
14+
-->
1615

17-
## Why Hermes
16+
**Current skill version: v4.2.0**
1817

19-
Hermes already runs your terminal, files, profiles, and cron. What it often lacks out of the box is a **strict house style** for the bash that manages real services (Docker, local inference, agent stack tools).
18+
## Why this exists
2019

21-
`scripts-bash` gives Hermes:
20+
Hermes already orchestrates terminal, files, profiles, cron, and secrets. What it still needs for serious ops work is a **rigid house style** so every installer looks the same, fails cleanly, and reads like a product - not vibecode.
2221

23-
- A locked **header + color + spinner + ROUTINE/case** standard
24-
- An executable **template** agents copy instead of freestyling
25-
- A **SCREAMING_SNAKE** global registry so names stay stable
26-
- An **authoring recipe** so humans and agents create the same quality
27-
- Hard gates: `bash -n`, full scripts, no secret dumps, products outside the skill tree
22+
`scripts-bash` teaches Hermes (and you) to ship bash with:
2823

29-
Use it so Hermes output matches production ops scripts - cinematic logs, clean Ctrl+C, idempotent install paths - the kind of bash you keep for years.
24+
| Pillar | What you get |
25+
|--------|----------------|
26+
| **Locked skeleton** | Header, colors, spinners, `ROUTINE` + `case`, `sexit` footer |
27+
| **Stable names** | SCREAMING_SNAKE globals with a living registry |
28+
| **Authoring recipe** | 5-step path from intent to verified script |
29+
| **Craft bar** | Quote discipline, `[[ ]]`, dryrun, idempotent install, no secret dumps |
30+
| **Lean package** | Skill law only - your host installers stay in your workspace |
3031

31-
## Install (drop-in)
32+
Complements Hermes. Does not replace it. Does not claim to be a general "learn bash" course.
33+
34+
## Install (Hermes drop-in)
3235

3336
```bash
3437
git clone https://github.com/Unix-Dev-Ops/scripts-bash.git
@@ -44,50 +47,92 @@ In a Hermes session:
4447
/skill scripts-bash
4548
```
4649

47-
Optional: mirror into a profile:
50+
Optional profile mirror (e.g. a coding profile):
4851

4952
```bash
5053
cp -a ~/.hermes/skills/software-development/scripts-bash \
5154
~/.hermes/profiles/<profile>/skills/
5255
```
5356

54-
## Quick use
57+
Standing rule (recommended in SOUL / AGENTS):
58+
59+
```text
60+
For long-lived bash installer/manager scripts: load skill scripts-bash first.
61+
Products go under profile workspace/installers/ or workspace/scripts/.
62+
```
63+
64+
## Quickstart
5565

5666
```text
57-
Load scripts-bash. Copy the template to
58-
workspace/installers/mytool/installer-mytool.sh
59-
Purpose: manage mytool. Routines: install, status, uninstall.
60-
No sudo.
67+
Load scripts-bash.
68+
Copy templates/template-base.sh to workspace/installers/mytool/installer-mytool.sh
69+
Purpose: manage mytool on port 9090.
70+
Routines: install, update, start, stop, status, uninstall.
71+
No sudo. Paths under ~/.hermes-programs/mytool/.
72+
```
73+
74+
Then verify:
75+
76+
```bash
77+
bash -n workspace/installers/mytool/installer-mytool.sh
78+
# shellcheck if available
79+
bash workspace/installers/mytool/installer-mytool.sh status
6180
```
6281

63-
Read **`skills/software-development/scripts-bash/references/authoring.md`** for the full 5-step recipe.
82+
Full walkthrough: [`skills/software-development/scripts-bash/references/authoring.md`](skills/software-development/scripts-bash/references/authoring.md)
6483

6584
## Package layout
6685

6786
```text
6887
skills/software-development/scripts-bash/
69-
SKILL.md # Hermes skill entry (frontmatter)
70-
references/template-base.sh # executable skeleton
71-
references/screaming-snake-case-variables.md
72-
references/authoring.md # how to create excellent scripts
88+
SKILL.md # Hermes skill entry
89+
references/template-base.sh # executable skeleton (source of truth)
90+
references/screaming-snake-case-variables.md # global name registry
91+
references/authoring.md # how to create excellent scripts
7392
templates/template-base.sh
74-
examples/minimal-service-installer.sh # ship-safe sample only
93+
examples/minimal-service-installer.sh # ship-safe sample only
7594
README.md / PUBLISH.md
7695
```
7796

78-
**Not in this repo:** private production installers, host design briefs, API keys.
97+
**Not in this repo:** private production installers, host design briefs, API keys, Kaggle/Google app code.
7998

80-
## Contributing / maintainers
99+
## What "good" looks like
81100

82-
- [CONTRIBUTING.md](CONTRIBUTING.md) - PRs, conventional commits, review bar
83-
- [MAINTAINERS.md](MAINTAINERS.md) - branch protection expectations
84-
- [SECURITY.md](SECURITY.md) - private vulnerability reports
85-
- CODEOWNERS requires review from **@Unix-Dev-Ops**
101+
- Author / Date / Ver / Name / Define header (column-aligned)
102+
- Braille spinners + clean Ctrl+C (`SPINNER_PID` + trap)
103+
- Green labels, cyan body, bright-red errors - cinematic `sleep 0.05` pacing
104+
- `cmd_exit=$?` **before** `stop_spinner`
105+
- `show_usage` exits 0 **without** the Completd footer; success paths end in `sexit`
106+
- Prefer explicit failure checks on large installers (house style); do not blind-apply `set -e`
107+
108+
## Contributing
109+
110+
PRs welcome. Maintainer review required.
111+
112+
- [CONTRIBUTING.md](CONTRIBUTING.md) - workflow, checklist, conventional commits
113+
- [MAINTAINERS.md](MAINTAINERS.md) - branch protection / merge style
114+
- [SECURITY.md](SECURITY.md) - private vuln reports
115+
- [CODEOWNERS](.github/CODEOWNERS) - `@Unix-Dev-Ops`
116+
117+
```bash
118+
bash -n skills/software-development/scripts-bash/references/template-base.sh
119+
bash -n skills/software-development/scripts-bash/templates/template-base.sh
120+
bash -n skills/software-development/scripts-bash/examples/minimal-service-installer.sh
121+
```
86122

87123
## Related
88124

89-
- Hermes Agent: https://github.com/NousResearch/hermes-agent
90-
- Hermes docs: https://hermes-agent.nousresearch.com/docs
125+
| Project | Role |
126+
|---------|------|
127+
| [Hermes Agent](https://github.com/NousResearch/hermes-agent) | The agent this skill serves |
128+
| [Hermes docs](https://hermes-agent.nousresearch.com/docs) | Official documentation |
129+
| Skills hub / local skills | Drop-in path under `~/.hermes/skills/` |
130+
131+
## Author
132+
133+
**Vituvo** ([@Unix-Dev-Ops](https://github.com/Unix-Dev-Ops))
134+
135+
Built for real Hermes operators who manage Docker, local inference, and agent infrastructure with bash that does not apologize.
91136

92137
## License
93138

docs/assets/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Hero assets
2+
3+
Place `scripts-bash-hero.png` here (recommended ~1536x1024).
4+
5+
README embeds: `docs/assets/scripts-bash-hero.png`
6+
7+
Style target: cyberpunk Hermes + terminal HUD panels (see Toni / hermes-a2a-bridge).

0 commit comments

Comments
 (0)