docs: update for v1.8.0 with npx usage, mesh, and messaging

This commit is contained in:
Rohit Ghumare
2026-01-30 18:04:33 +00:00
parent e22193f823
commit d0b5151683
5 changed files with 251 additions and 22 deletions
+14 -15
View File
@@ -22,6 +22,10 @@
> **What are AI Agent Skills?** Skills are instruction files that teach AI coding agents how to handle specific tasks - like processing PDFs, following React best practices, or enforcing security patterns. Think of them as plugins for your AI assistant.
```bash
# Quick start (no install required)
npx skillkit@latest
# Or install globally
npm install -g skillkit
```
@@ -78,22 +82,17 @@ SkillKit features a polished, interactive CLI with visual feedback:
## 5-Minute Quick Start
```bash
# 1. Install SkillKit globally
# Launch interactive TUI (no install required)
npx skillkit@latest
# Or with specific commands:
npx skillkit recommend # Get smart recommendations
npx skillkit install anthropics/skills # Install official skills
npx skillkit sync # Sync to your AI agent
# For frequent use, install globally:
npm install -g skillkit
# 2. Launch the interactive TUI (easiest way to start)
skillkit
# Or use CLI commands directly:
# 3. Get personalized skill recommendations
skillkit recommend
# 4. Install skills from the marketplace
skillkit install anthropics/skills
# 5. Sync to your AI agent
skillkit sync
skillkit # Launch TUI
```
## Core Features
+12 -1
View File
@@ -5,7 +5,18 @@ description: Install SkillKit and set up your first project
# Installation
SkillKit is distributed as an npm package. Current version: **v1.7.5**
SkillKit is distributed as an npm package. Current version: **v1.8.0**
## Quick Start (No Install)
```bash
# Run without installing
npx skillkit@latest
# Run specific commands
npx skillkit recommend
npx skillkit install anthropics/skills
```
## Install Globally
+118
View File
@@ -0,0 +1,118 @@
---
title: Mesh Network
description: Multi-machine agent distribution with secure peer-to-peer communication
---
# Mesh Network
SkillKit's mesh network enables secure communication between AI agents across multiple machines. Share skills, synchronize memory, and collaborate across your development environment.
## Quick Start
```bash
# Initialize mesh on your machine
npx skillkit mesh init
# Discover other hosts on your LAN
npx skillkit mesh discover
# Add a specific host
npx skillkit mesh add 192.168.1.100
```
## Security
The mesh network uses enterprise-grade security:
- **Ed25519** - Peer identity and message signing
- **XChaCha20-Poly1305** - End-to-end message encryption
- **TLS 1.3** - Transport layer security
- **JWT with EdDSA** - Authentication tokens
### Initialize Security
```bash
# Generate encryption keys
npx skillkit mesh security init
# Check security status
npx skillkit mesh security status
```
### Peer Trust Management
```bash
# Trust a peer by fingerprint
npx skillkit mesh peer trust abc123def456
# Revoke a peer's trust
npx skillkit mesh peer revoke abc123def456
# List trusted peers
npx skillkit mesh peer list
```
## Commands Reference
| Command | Description |
|---------|-------------|
| `mesh init` | Initialize mesh network |
| `mesh add <address>` | Add a host to mesh |
| `mesh remove <id>` | Remove a host |
| `mesh list` | List known hosts |
| `mesh discover` | Discover hosts on LAN |
| `mesh health` | Check host health |
| `mesh status` | Show mesh status |
| `mesh security init` | Setup encryption keys |
| `mesh security status` | Show security status |
| `mesh peer trust <id>` | Trust a peer |
| `mesh peer revoke <id>` | Revoke peer trust |
| `mesh peer list` | List trusted peers |
## Security Levels
| Level | Discovery | Transport | Auth | Use Case |
|-------|-----------|-----------|------|----------|
| `development` | open | none | none | Local dev |
| `signed` | signed | optional | optional | Trusted LAN |
| `secure` (default) | signed | required | required | Production |
| `strict` | trusted-only | required | mTLS | High security |
## Architecture
The mesh network uses:
1. **UDP Multicast** - LAN discovery with signed announcements
2. **WebSocket (WSS)** - Real-time bidirectional communication
3. **HTTPS** - RESTful API for management
All messages are signed and optionally encrypted based on your security level.
## Programmatic API
```typescript
import { MeshHost, PeerIdentity } from '@skillkit/mesh';
// Generate identity
const identity = await PeerIdentity.generate();
// Create mesh host
const host = new MeshHost({
hostId: 'my-workstation',
identity,
security: { mode: 'secure' },
});
await host.start();
// Send message to peer
await host.send('peer-fingerprint', {
type: 'skill-sync',
payload: { skills: ['react-patterns'] },
});
```
## Next Steps
- [Inter-Agent Messaging](/docs/messaging) - Send messages between agents
- [Memory System](/docs/memory) - Share learnings across the mesh
+98
View File
@@ -0,0 +1,98 @@
---
title: Inter-Agent Messaging
description: Send messages between AI agents across the mesh network
---
# Inter-Agent Messaging
SkillKit's messaging system enables asynchronous communication between AI agents. Send code reviews, share insights, and coordinate work across your team.
## Quick Start
```bash
# Send a message
npx skillkit message send
# View inbox
npx skillkit message inbox
# Read a message
npx skillkit message read <message-id>
```
## Commands Reference
| Command | Description |
|---------|-------------|
| `message send` | Send message to agent |
| `message inbox` | View inbox |
| `message read <id>` | Read a message |
| `message reply <id>` | Reply to message |
| `message archive <id>` | Archive message |
| `message sent` | View sent messages |
| `message status` | Messaging status |
## Message Types
Messages can include:
- **Text** - Plain text messages
- **Code** - Code snippets with syntax highlighting
- **Diffs** - Code changes and patches
- **Skills** - Skill file attachments
## Priority Levels
- **urgent** - Immediate attention required
- **normal** - Standard priority (default)
- **low** - Can be addressed when convenient
## Inbox Management
```bash
# View unread messages
npx skillkit message inbox --unread
# Archive old messages
npx skillkit message archive <id>
# View sent messages
npx skillkit message sent
```
## Programmatic API
```typescript
import { MessagingClient } from '@skillkit/messaging';
import { MeshHost } from '@skillkit/mesh';
// Create messaging client
const messaging = new MessagingClient({
meshHost: host,
storagePath: '~/.skillkit/messages',
});
await messaging.init();
// Send a message
await messaging.send({
to: 'claude@laptop',
subject: 'Code review completed',
body: 'I reviewed the auth module...',
priority: 'normal',
});
// Listen for new messages
messaging.on('message', (msg) => {
console.log('New message from:', msg.from);
});
```
## TUI Navigation
In the Terminal UI, press `j` to access the Messages screen.
## Next Steps
- [Mesh Network](/docs/mesh) - Configure the underlying network
- [Team Collaboration](/docs/teams) - Share skills with your team
+9 -6
View File
@@ -7,15 +7,18 @@ description: Get up and running with SkillKit in 5 minutes
This guide walks you through installing SkillKit, setting up your first project, and installing skills.
## 1. Install SkillKit
## 1. Run SkillKit
No installation required! Use npx:
```bash
npx skillkit@latest
```
Or install globally for frequent use:
```bash
npm install -g skillkit
```
Verify installation:
```bash
skillkit --version
```