Quick Start

Get up and running with Hugsy in less than 5 minutes.

Prerequisites

Node.js version 18.0 or higher
npm or yarn package manager
Claude Code installed and configured

Installation

$ npm install -g @hugsylabs/hugsy

Or with yarn:

$ yarn global add @hugsylabs/hugsy

Initialize Your Project

Navigate to your project directory and run:

$ hugsy init

This will create a .hugsyrc.json configuration file with default settings.

Basic Configuration

The configuration file looks like this:

{
  "extends": "@hugsylabs/hugsy-compiler/presets/development",
  "permissions": {
    "allow": [
      "Read(**)",
      "Write(**/*.ts)",
      "Bash(npm test)",
      "Bash(git *)"
    ],
    "deny": [
      "Write(**/node_modules/**)",
      "Bash(rm -rf /)"
    ]
  },
  "env": {
    "NODE_ENV": "development"
  },
  "commands": {
    "presets": [
      "@hugsylabs/hugsy-compiler/presets/slash-commands-common"
    ]
  }
}

Apply Configuration

Install and activate your configuration:

$ hugsy install

Check configuration status:

$ hugsy status

Next Steps

You're all set!

Hugsy is now configured and ready to enhance your Claude Code experience.

→ Learn about presets → Explore plugin development → Explore the source code