Explains how to import error content from a local XLSX (Excel) file. Simple to use without any external API or authentication.

Quick Start with Template

Download the pre-made XLSX template to get started right away. Includes both Korean and English sheets.

Download XLSX Template

TIP

After downloading, edit the data and run huh pull.

---

Writing an XLSX File

In Excel, create the first row as a header row:

trackId	type	message	title	image	severity	actionLabel	actionType	actionTarget
ERR_LOGIN_FAILED	TOAST	Login failed
ERR_SESSION_EXPIRED	MODAL	Session has expired	Session Expired		ERROR	Login Again	REDIRECT	/login
ERR_NOT_FOUND	PAGE	Page not found	404	/img/404.png	INFO	Go Home	REDIRECT	/

TIP

Even if entered in lowercase, the CLI will automatically convert to uppercase. Custom types (BANNER, SNACKBAR, etc.) can also be used freely.

Column Rules

Column Name	Required	Description
trackId	Yes	Unique error ID (e.g., ERR_LOGIN_FAILED)
type	Yes	TOAST, MODAL, PAGE, or custom type
message	Yes	Error message. Supports template variables
title		Error title (for modal, page)
image		Image URL (for page)
severity		INFO, WARNING, ERROR, CRITICAL, or custom severity
actionLabel		Action button text
actionType		REDIRECT, RETRY, BACK, DISMISS, or custom action
actionTarget		URL to navigate to for REDIRECT

Configuration

.huh.config.json

{
  "source": {
    "type": "xlsx",
    "filePath": "./errors.xlsx"
  },
  "output": "./src/huh.json"
}

To specify a particular sheet, use the sheet option:

{
  "source": {
    "type": "xlsx",
    "filePath": "./errors.xlsx",
    "sheet": "ErrorList"
  },
  "output": "./src/huh.json"
}

If sheet is not specified, the first sheet is used.

.huh.config.ts

import { defineConfig } from '@sanghyuk-2i/huh-cli';

export default defineConfig({
  source: {
    type: 'xlsx',
    filePath: './errors.xlsx',
    // sheet: 'ErrorList',  // Optional: uses first sheet if not specified
  },
  output: './src/huh.json',
});

filePath can be a relative or absolute path. Relative paths are resolved from process.cwd().

Fetching Data

If successful, a JSON file will be generated at the output path.

Notes

• Only .xlsx format is supported (legacy .xls format is not supported).
• The sheet must contain a header row + at least 1 data row.
• If the specified sheet name does not exist, an error will be shown along with the list of available sheets.
• Uses the SheetJS library.