### Install Dependencies

Source: https://github.com/hcengineering/huly-docs/blob/main/README.md

Run this command to install project dependencies for local development.

```bash
npm install
```

--------------------------------

### Run Development Server

Source: https://github.com/hcengineering/huly-docs/blob/main/README.md

Execute this command to start the local development server. The documentation will be accessible at http://localhost:4321 or the next available port.

```bash
npm run dev
```

--------------------------------

### Clone and Configure Huly Self-Hosting

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Steps to clone the Huly self-hosting repository and initial configuration guidance. Refer to the README for detailed setup.

```bash
git clone https://github.com/hcengineering/huly-selfhost
cd huly-selfhost
# Follow README for: AWS SES email, Love Service (audio/video),
# AI Service, OpenID Connect, GitHub OAuth, disabling sign-up.
```

--------------------------------

### Huly Workspace Setup and Configuration

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Follow these steps to set up a Huly workspace, invite team members, configure invite settings, and enable modules. Self-hosting instructions are also provided.

```bash
# 1. Sign up at huly.io (cloud) or self-host:
#    https://github.com/hcengineering/huly-selfhost

# 2. Create your workspace — provide a name when prompted after sign-up.

# 3. Invite team members:
#    Profile icon (bottom-left) → "Invite to workspace" → "Get invite link"
#    Share the link with teammates.
#
#    OR add employees directly:
#    Contacts → Employee → "+ Employee" → enter name + email
#    An invitation email is sent automatically.

# 4. Configure invite link settings (optional):
#    Settings (hamburger icon, top-left) → "Invite settings"
#    - Duration: how long the link is valid
#    - Email mask: restrict to a domain, e.g., "@yourcompany.com"
#    - Limit: max number of uses

# 5. Enable/disable modules:
#    Settings → Configure
#    Toggle modules such as Tracker, Documents, Cards, Recruiting, etc.

# 6. Self-host with desktop app pointed at your server (macOS example):
open -a "Huly" --args --server https://your-huly-server.com

# 7. Export workspace data at any time:
#    Settings → Export → choose JSON or CSV
```

--------------------------------

### Example Code Review Template

Source: https://github.com/hcengineering/huly-docs/blob/main/src/content/docs/advanced-settings/text-templates.mdx

Standardize feedback on code reviews with this template, which includes placeholders for the specific code location, the observation, and a suggested change.

```text
    Code: [File/Line reference]
    Observation: [Issue/Feedback]
    Suggested change: [Proposed solution]
```

--------------------------------

### Example Meeting Invite Template

Source: https://github.com/hcengineering/huly-docs/blob/main/src/content/docs/advanced-settings/text-templates.mdx

Use this template to standardize recurring meeting announcements, including placeholders for meeting name, date, time, and agenda link.

```text
    Reminder: Our [Meeting Name] is scheduled for [Date and Time].
    Please review the agenda here: [Link].
```

--------------------------------

### Build and Preview Production

Source: https://github.com/hcengineering/huly-docs/blob/main/README.md

Use these commands to build the production version of the documentation and then serve a preview. This includes type checking.

```bash
npm run build
npm run preview
```

--------------------------------

### Add an inline comment

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Instructions for adding threaded discussions to specific text within a document. This feature is detailed further in the Inline Comments guide.

```text
# Add an inline comment (threaded discussion on specific text):
# Highlight text → floating toolbar → comment icon (see Inline Comments guide)
```

--------------------------------

### Huly Platform API and Import Tool Documentation

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Links to documentation for the Huly Platform API and the Unified Import Tool, which facilitates data import into Huly.

```bash
# Huly Platform API:
# Docs: https://github.com/hcengineering/huly-examples/tree/main/platform-api#readme
# Provides basic REST endpoints for custom integrations and extensions.

# Huly Import Tool (Unified Import Format):
# Docs: https://github.com/hcengineering/platform/tree/develop/dev/import-tool#readme
# Convert data to Huly's human-readable intermediate format, then import.

# Import from Notion:
# https://github.com/hcengineering/platform/blob/develop/dev/import-tool/docs/notion/README.md

# Import from ClickUp:
# https://github.com/hcengineering/platform/blob/develop/dev/import-tool/docs/clickup/README.md
```

--------------------------------

### Derived Types (Inheritance) in Huly Cards

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Explanation of derived types (inheritance) in Huly Cards, showing how a derived Type inherits properties from its parent. Includes an example hierarchy.

```text
# Derived Types (inheritance):
# On a Type's settings page → TYPES section → "+"
# The derived Type inherits all parent properties.
# Example hierarchy:
#   Game Component
#   ├── Character (Speed, Jump height, Movement modes, Max health, Stamina)
#   │   ├── Player  (Abilities, XP)
#   │   ├── Enemy   (Attack patterns)
#   │   └── NPC     (Affiliation, Essential?, Respawn?)
#   ├── Item        (Item type, Effect, Rarity)
#   └── Environment (Size, Interactive?)
```

--------------------------------

### Connect Desktop App to Self-hosted Server (macOS)

Source: https://github.com/hcengineering/huly-docs/blob/main/src/content/docs/getting-started/self-host.mdx

Connect the Huly Desktop App to your self-hosted server on macOS using the 'open' command with the --args --server option, or by directly executing the Huly binary.

```bash
open -a "Huly" --args --server https://your-huly-server.com
```

```bash
/Applications/Huly.app/Contents/MacOS/Huly --server https://your-huly-server.com
```

--------------------------------

### Create a document

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Instructions for creating a new document within a teamspace or nested within another document. A title is required.

```text
# Create a document:
# "+ Create a document" button → select teamspace → enter title → Create
# OR hover any teamspace/document → click "+" to nest a new document inside it.
```

--------------------------------

### Connect Huly Desktop App to Self-Hosted Server

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Instructions for connecting the Huly Desktop App to a self-hosted Huly server on macOS and Windows.

```bash
open -a "Huly" --args --server https://your-huly-server.com
```

```powershell
"C:\Program Files\Huly\Huly.exe" --server https://your-huly-server.com
```

--------------------------------

### Backup and Restore Self-Hosted Workspace

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Procedure for backing up a self-hosted Huly workspace using the desktop app, and restoring it on another instance.

```bash
# Desktop app → Menu → Backup → saves workspace backup to filesystem
# Restore backup on target instance via the same menu.
```

--------------------------------

### Huly Task Tracking: Project Creation and Settings

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Learn how to create a new project within the Huly Tracker module and configure its settings, including type, title, identifier, description, icon, default assignee, default status, owners, and privacy.

```bash
# Create a project:
# Tracker (checkbox icon in left sidebar) → side panel open →
# Hover "Your Projects" → click "+" OR dropdown next to "+ New issue" → "Create project"

# Project settings:
# - Project type    : defaults to "Classic project"; custom types available in settings
# - Title           : human-readable name
# - Identifier      : auto-generated abbreviation for issue IDs (e.g., "FE-42")
# - Description     : optional project description
# - Icon            : choose icon + color or emoji
# - Default assignee: member assigned to new issues by default
# - Default status  : status pre-selected for all new issues
# - Owners          : members with permission to edit project details
# - Make private    : restrict visibility to listed members
```

--------------------------------

### Connect Desktop App to Self-hosted Server (Windows)

Source: https://github.com/hcengineering/huly-docs/blob/main/src/content/docs/getting-started/self-host.mdx

To connect the Huly Desktop App to your self-hosted server on Windows, modify the shortcut's target field by adding the --server option with your server URL.

```batch
"C:\Program Files\Huly\Huly.exe" --server https://your-huly-server.com
```

--------------------------------

### Create a teamspace

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Used to create a new teamspace for organizing documents. Fields include title, description, icon, owner, privacy, members, and auto join settings.

```text
# Create a teamspace:
# Documents (book icon) → hover "Teamspaces" → "+" OR dropdown → "Create teamspace"
# Fields: title, description, icon, owner, privacy, members, auto join
```

--------------------------------

### Huly Roles and Permissions Management

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Understand the layered permission system in Huly, including workspace-level roles, space-type roles, per-space privacy settings, and global space admins. Specific instructions for assigning roles in Controlled Documents are included.

```bash
# Workspace-level roles (Settings → Owners):
# - Owner     : full control, can delete workspace and remove members
# - Maintainer: same as Owner except cannot delete workspace or remove owners
# - User      : no workspace settings access
# - Guest     : limited to spaces that explicitly allow Guest access
# - Readonly  : view-only access across the entire workspace

# TraceX workspaces add: Qualified User, Manager, QARA

# Space-type roles (Settings → SPACE TYPES → [type] → Roles):
# 1. Click "+" to create a role (e.g., "Reviewer")
# 2. Click the role to assign specific permissions (update, archive, delete)
# 3. Assign roles to members per space using that type

# Per-space privacy (when creating or editing any project/teamspace/drive):
# - Toggle "Make private" → only listed members can access the space
# - Toggle "Auto join" ON  → new workspace members join automatically
# - Toggle "Auto join" OFF → new members must be added manually

# Global space admins (Settings → WORKSPACE SETTINGS → Spaces):
# Add admins who can archive/delete any project but cannot delete the workspace

# Assigning roles for Controlled Documents:
# Open document space settings → "Edit documents space"
# Add members → assign each member to a role (Author, Reviewer, Approver, etc.)
```

--------------------------------

### Authoring Workflow for Controlled Documents

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Overview of the authoring workflow for Controlled Documents in Huly, including document creation, editing, assigning owners/authors, and the author signing step.

```text
# Authoring workflow:
# 1. Create a document from a template or from scratch.
# 2. Edit with rich-text formatting (same as Documents module).
# 3. Assign owners (responsible) and authors (content creators) separately.
# 4. Author signs the document before sending for review (since Jan 2025).
```

--------------------------------

### Document Formatting

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Covers markdown formatting, text styling via a floating toolbar, and adding elements like images, tables, and diagrams.

```text
# Formatting:
# - Type markdown directly (# headers, **bold**, `code`, > blockquote, - lists)
# - Select text → floating toolbar for formatting options
# - Hover text → click "+" on left margin for: image, table, separator, diagram
```

--------------------------------

### Mermaid Diagram Syntax

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Use MermaidJS syntax to create diagrams within Huly. The diagram renders live, and the editor can be collapsed to show only the diagram.

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[End]
```

--------------------------------

### Create a Card in Huly Cards

Source: https://context7.com/hcengineering/huly-docs/llms.txt

Steps for creating a new Card (instance of a Type) in Huly Cards. This involves selecting a Type and filling in its properties and any applied Tags.

```text
# --- Create a Card (instance) ---
# Cards module → select Type space → "+ New Card"
# Fill in properties defined by the Type + any Tags applied to it.
```