Getting Started with hyphn

Unified configuration for your AI tools

Setup Guide

  1. Prerequisites

    Ensure you have Node.js (v18+) and npm installed on your system.

    node --version
  2. Installation

    Install hyphn globally via npm:

    npm install -g @fwdslsh/hyphn
  3. Initialization

    Initialize your local configuration directory (`~/.hyphn`). This creates the standard structure for your agents and skills.

    hyphn init
  4. Platform Setup

    Configure your installed AI tools (OpenCode, Claude Code) to recognize hyphn.

    hyphn setup

Understanding Directory Structure

Your `~/.hyphn` directory is the source of truth for your AI workflows.

~/.hyphn/
├── config.yaml       # Main configuration
├── agents/           # Custom agent definitions
│   └── my-agent.md
├── commands/         # Custom slash commands
│   └── test.sh
├── skills/           # Reusable skills
│   └── deploy-skill/
└── sources/          # External source repositories

Adding Sources

Share configuration with your team by adding git repositories as sources.

# Add a local directory or git repo hyphn sources add ~/work/team-ai-config # Update all sources hyphn sources update
Read Documentation