Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Hermes House environment template
# Copy this file to .env and fill in the secrets you actually use.

# Required for the docs' default integrations
ANTHROPIC_API_KEY=
TELEGRAM_BOT_TOKEN=
GITHUB_TOKEN=

# Optional integrations mentioned across the repo
OPENROUTER_API_KEY=
MINIMAX_API_KEY=
NVIDIA_API_KEY=
HF_TOKEN=
58 changes: 36 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@ Persistent, layered memory architecture:
| L3 | Semantic | Knowledge | Long-term |

### 🛠️ Modular Skills Library
**63+ pre-built skills** ready to use:
**101 pre-built skills** with tiered installation:

- `--core` — 32 A-tier core skills
- `--standard` — 78 A+B recommended skills (default)
- `--full` — all 101 skills, including specialized/personal C-tier skills

| Category | Skills |
|----------|--------|
Expand Down Expand Up @@ -115,48 +119,58 @@ Persistent, layered memory architecture:
## 🚀 Quick Start

### Prerequisites
- Node.js 22.x or higher
- npm 10.x or higher
- Telegram account (for bot integration)
- GitHub account (for automation)
- Hermes Agent CLI installed
- Git + Bash
- Telegram account (optional, for bot integration)
- GitHub account / PAT (optional, for automation)
- Node.js 22.x only if you plan to run the `projects/*` sub-projects

### Installation

```bash
# Clone the repository
# 1) Install Hermes Agent core first
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

# 2) Clone the Harmes-House skill/evolution hub
git clone https://github.com/clowlove/Harmes-House.git
cd Harmes-House

# Explore available skills
ls skills/
# 3) Install the recommended A+B skill pack into the active Hermes home
bash scripts/install.sh

# Optional install modes:
# bash scripts/install.sh --core # 32 core skills
# bash scripts/install.sh --standard # 78 recommended skills (default)
# bash scripts/install.sh --full # all 101 skills

# View AI growth journal
cat hermes-journal.md
# 4) Verify
hermes skills list
```

### Configuration

```bash
# Copy environment template
# Copy environment template when using Telegram / GitHub integrations
cp .env.example .env

# Edit with your API keys
nano .env
```

Required environment variables:
Common environment variables:
- `ANTHROPIC_API_KEY` — Claude API key
- `TELEGRAM_BOT_TOKEN` — Telegram bot token
- `TELEGRAM_BOT_TOKEN` — Telegram bot token
- `GITHUB_TOKEN` — GitHub Personal Access Token
- `OPENROUTER_API_KEY` / `MINIMAX_API_KEY` — optional model providers

### Running

```bash
# Development mode
npm run dev
# Start Hermes normally
hermes

# Production mode
npm start
# Or preload one or more installed skills
hermes -s hermes-agent,github-pr-workflow
```

---
Expand All @@ -168,11 +182,11 @@ Harmes-House/
├── AGENTS.md # AI identity definition
├── hermes-journal.md # AI self-recorded growth journal
├── skills/ # 63+ modular skills
├── skills/ # 101 modular skills
│ ├── trendradar/ # News aggregation skill
│ ├── github/ # GitHub automation
│ ├── data-science/ # Data analysis tools
│ └── ... # 60+ more skills
│ └── ... # more skills
├── docs/ # Documentation
│ ├── architecture/ # System architecture
Expand Down Expand Up @@ -203,7 +217,7 @@ Harmes-House/
Latest entries from [hermes-journal.md](hermes-journal.md):

<!-- JOURNAL_PREVIEW -->
- **2026-05-17** — Skill library expanded to 63+ skills
- **2026-05-17** — Skill library expanded to 101 skills
- **2026-05-15** — GitHub monetization infrastructure deployed
- **2026-05-12** — Self-improvement engine v2 complete
- **2026-05-10** — Documentation site launched
Expand All @@ -215,7 +229,7 @@ Latest entries from [hermes-journal.md](hermes-journal.md):
| Metric | Value |
|--------|-------|
| Days Running | 14+ |
| Skills Available | 63+ |
| Skills Available | 101 |
| Git Commits | 200+ |
| Sub-projects | 2 |
| Code Review PRs | 20+ |
Expand All @@ -235,7 +249,7 @@ Latest entries from [hermes-journal.md](hermes-journal.md):
| `huggingface` | Model Hub integration | ML/AI |
| `telegram` | Bot commands & notifications | Automation |

**[View all 63+ skills →](docs/skills.md)**
**[View skills →](docs/skills.md)** — full tier audit: [docs/SKILLS_AUDIT.md](docs/SKILLS_AUDIT.md)

---

Expand Down
334 changes: 334 additions & 0 deletions docs/SKILLS_AUDIT.md

Large diffs are not rendered by default.

32 changes: 18 additions & 14 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,28 @@

Detailed guides for Hermès Agent features.

## Core Features
## Available References

- [Memory Management](./memory-management.md) - Understanding the 4-layer memory system
- [Skills Library](./skills-library.md) - Browse and use 60+ built-in skills
- [Notifications](./notifications.md) - Configure push notifications
- [Skills Index](../skills.md) — browse the skill catalog
- [Architecture Patterns](../evolution/architecture-patterns.md) — reusable AI agent design patterns
- [Technical Discoveries](../evolution/tech-discoveries.md) — experiments and implementation notes
- [TrendRadar Discoveries](../projects/discovered-projects.md) — projects and patterns found during exploration
- [Metrics](../metrics/index.md) — performance tracking and status summaries

## Integrations
## Planned Guides

- [GitHub Integration](./github-integration.md) - Automate repository tasks
- [Telegram Bot](./telegram-bot.md) - Master the Telegram interface
- [HuggingFace](./huggingface.md) - Use models and datasets
These guides are referenced in the index but not written yet:

## Operations

- [Cron Jobs](./cron-jobs.md) - Schedule recurring tasks
- [Self-Improvement](./self-improvement.md) - AI-powered growth
- [Backup System](./backup-system.md) - Protect your data
- Memory Management
- Skills Library
- Notifications
- GitHub Integration
- Telegram Bot
- HuggingFace
- Cron Jobs
- Self-Improvement
- Backup System

---

*Request a new guide via GitHub Issues.*
*Request a new guide via GitHub Issues.*
10 changes: 10 additions & 0 deletions docs/skills.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# 技能索引

Harmes-House 当前包含 101 个技能。默认安装只启用推荐的 A+B 档,避免把强场景/个人化/C 档技能全部塞进 Hermes。

```bash
bash scripts/install.sh --core # A 档核心,32 个
bash scripts/install.sh --standard # A+B 推荐,78 个,默认
bash scripts/install.sh --full # 全量,101 个
```

完整分级见 [SKILLS_AUDIT.md](SKILLS_AUDIT.md)。

## devops

| 技能 | 描述 | 状态 |
Expand Down
54 changes: 33 additions & 21 deletions docs/tutorials/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,74 @@
# Quick Start Guide

Get Hermès Agent running in 5 minutes.
Get Hermès Agent + the Harmes-House skill pack running in 5 minutes.

## Prerequisites

- Node.js 22.x
- npm 10.x
- Telegram account
- GitHub account (for integrations)
- Hermes Agent CLI
- Git + Bash
- Telegram account (optional)
- GitHub account / PAT (optional, for integrations)
- Node.js 22.x only for `projects/*` sub-projects

## Step 1: Installation

```bash
# Clone the repository
# Install Hermes Agent core
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

# Clone the Harmes-House skill/evolution hub
git clone https://github.com/clowlove/Harmes-House.git
cd Harmes-House

# Install dependencies
npm install
# Install recommended A+B skills into the active Hermes home
bash scripts/install.sh

# Optional install modes:
# bash scripts/install.sh --core # 32 core skills
# bash scripts/install.sh --standard # 78 recommended skills (default)
# bash scripts/install.sh --full # all 101 skills
```

## Step 2: Configuration

```bash
# Copy environment template
# Copy environment template when using Telegram / GitHub integrations
cp .env.example .env

# Edit with your API keys
nano .env
```

Required environment variables:
Common environment variables:
- `ANTHROPIC_API_KEY` - Claude API key
- `TELEGRAM_BOT_TOKEN` - Telegram bot token
- `GITHUB_TOKEN` - GitHub PAT
- `OPENROUTER_API_KEY` / `MINIMAX_API_KEY` - optional model providers

## Step 3: Start

```bash
# Run in development
npm run dev
# Start Hermes normally
hermes

# Or run in production
npm start
# Or preload one or more installed skills
hermes -s hermes-agent,github-pr-workflow
```

## Step 4: Verify

1. Open Telegram
2. Send `/start` to your bot
3. You should receive a welcome message
```bash
hermes skills list
```

You should see Harmes-House skills available from your Hermes installation.

## What's Next?

- [Create your first skill](../tutorials/first-skill.md)
- [Set up TrendRadar](../tutorials/trendradar-guide.md)
- [Configure notifications](../guides/notifications.md)
- [Browse available skills](../skills.md)
- [Read the architecture patterns](../evolution/architecture-patterns.md)
- [Review the evolution log](../evolution/log-2026-05.md)

---

*Stuck? Check [Troubleshooting](./troubleshooting.md) or ask on Telegram.*
*Stuck? Run `hermes doctor` first, then check the repository issues or ask on Telegram.*
32 changes: 17 additions & 15 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# Tutorials

Collection of step-by-step guides for using Hermès Agent.
Collection of step-by-step guides for using Hermès Agent and Harmes-House.

## Getting Started
## Available

1. [Quick Start Guide](./getting-started.md) - Set up your first agent
2. [First Skill](./first-skill.md) - Create your first skill
3. [Memory System](./memory-system.md) - Understand the 4-layer memory
1. [Quick Start Guide](./getting-started.md) — install Hermes Agent and sync the Harmes-House skill pack
2. [Skills Index](../skills.md) — browse the available skills
3. [Architecture Patterns](../evolution/architecture-patterns.md) — understand the agent patterns used by the project
4. [Evolution Log](../evolution/log-2026-05.md) — follow the project growth history

## Intermediate
## Planned

4. [Using TrendRadar](./trendradar-guide.md) - Master news aggregation
5. [GitHub Automation](./github-automation.md) - Automate repo management
6. [Cron Jobs](./cron-jobs.md) - Schedule recurring tasks
These tutorials are planned but not written yet:

## Advanced

7. [Multi-Agent Architecture](./multi-agent.md) - Design agent systems
8. [Custom MCP Integration](./mcp-integration.md) - Extend capabilities
9. [Performance Optimization](./optimization.md) - Fine-tune your agent
- Create your first skill
- Set up TrendRadar
- Configure notifications
- GitHub automation
- Cron jobs
- Multi-agent architecture
- Custom MCP integration
- Performance optimization

---

*More tutorials coming soon. Request one via GitHub Issues.*
*More tutorials coming soon. Request one via GitHub Issues.*
Loading