https://github.com/o3co/hocon2
CLI tools to convert HOCON to JSON, YAML, TOML, and Java Properties
https://github.com/o3co/hocon2
cli config converter go golang hocon json properties toml yaml
Last synced: 3 months ago
JSON representation
CLI tools to convert HOCON to JSON, YAML, TOML, and Java Properties
- Host: GitHub
- URL: https://github.com/o3co/hocon2
- Owner: o3co
- License: apache-2.0
- Created: 2026-03-20T03:29:12.000Z (3 months ago)
- Default Branch: develop
- Last Pushed: 2026-04-02T16:56:05.000Z (3 months ago)
- Last Synced: 2026-04-03T04:43:43.391Z (3 months ago)
- Topics: cli, config, converter, go, golang, hocon, json, properties, toml, yaml
- Language: Go
- Size: 102 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.ja.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# hocon2 — Go 向け HOCON 変換 CLI
[](https://github.com/o3co/hocon2/actions/workflows/ci.yml)
[](https://pkg.go.dev/github.com/o3co/hocon2)
[](https://github.com/o3co/hocon2/releases/latest)
[](LICENSE)
Go 向け HOCON 変換ツール — [HOCON](https://github.com/lightbend/config/blob/main/HOCON.md) 設定ファイルを JSON、YAML、TOML、Java Properties に変換します。
HOCON (Human-Optimized Config Object Notation) は、人間にとって読みやすい JSON のスーパーセットです。コメント、変数参照（`${var}`）、インクルード、クォートやカンマの省略などをサポートしています。`hocon2` を使えば、HOCON をネイティブに扱えないツール向けに、広くサポートされたフォーマットへ変換できます。
パーサーには [go.hocon](https://github.com/o3co/go.hocon) を使用。[Lightbend のリファレンステストスイート](https://github.com/lightbend/config)で準拠性を検証済みです。
> **[Claude Code](https://claude.ai/claude-code)** (Anthropic) により設計・実装されました。
> [GitHub Copilot](https://github.com/features/copilot) および [OpenAI Codex](https://openai.com/index/openai-codex/) によるレビュー。
[English](README.md)
---
## クイックスタート
### 1. インストール
#### Go
```bash
go install github.com/o3co/hocon2/cmd/hocon2json@latest
go install github.com/o3co/hocon2/cmd/hocon2yaml@latest
go install github.com/o3co/hocon2/cmd/hocon2toml@latest
go install github.com/o3co/hocon2/cmd/hocon2properties@latest
```
#### バイナリリリース
[リリースページ](https://github.com/o3co/hocon2/releases/latest)からビルド済みバイナリをダウンロードできます（Linux/macOS/Windows、amd64/arm64）。
### 2. 使い方
```bash
# ファイルを変換
hocon2json app.conf
# 標準入力から読み込み
cat app.conf | hocon2yaml
# ヘルプを表示
hocon2json --help
```
## なぜ hocon2？
HOCON は設定の記述に最適ですが、多くのツールは JSON、YAML、TOML しか理解しません。`hocon2` がそのギャップを埋めます：
- **記述** は HOCON で（可読性が高く、組み合わせ可能で DRY）
- **デプロイ** はツールが必要とするフォーマットで（Kubernetes は JSON、Helm は YAML、Rust ツールは TOML、Java は Properties）
- **検証** はデプロイ前に CI で構文チェック（`-validate` フラグ）
## 対応フォーマット
| コマンド | 出力フォーマット |
|---|---|
| `hocon2json` | JSON |
| `hocon2yaml` | YAML |
| `hocon2toml` | TOML |
| `hocon2properties` | Java Properties |
## 使い方
### オプション
```bash
# コンパクト JSON 出力（空白なし）
hocon2json -compact app.conf
# インデント幅を指定（デフォルト: 2）
hocon2json -indent 4 app.conf
# ファイルに出力
hocon2json -o output.json app.conf
# 既存ファイルを上書き
hocon2json -o output.json -overwrite app.conf
```
`-compact` と `-indent` は `hocon2json` のみで使用可能。`-o` と `-overwrite` は全コマンド共通です。
### 複数ファイルのマージ
引数に複数ファイルを指定できます。**右優先**でマージされます — 後に指定したファイルのキーが優先されます：
```bash
hocon2toml base.conf env.conf local.conf
```
これは `local.conf` が `env.conf` を、`env.conf` が `base.conf` を上書きする動作です。レイヤード構成（ベース → 環境別 → ローカル上書き）に便利です。
### 環境変数
HOCON の変数参照（`${VAR}`）は環境変数を解決します：
```bash
# 環境変数をインラインで渡す
DB_HOST=prod-db.example.com hocon2json app.conf
# または export する
export DB_HOST=prod-db.example.com
hocon2json app.conf
```
`app.conf`:
```hocon
database {
host = ${DB_HOST}
host = ${?DB_HOST} # オプショナル: DB_HOST が設定されている場合のみ使用
}
```
### 変換例
`app.conf`:
```hocon
database {
host = "localhost"
port = 5432
pool_size = 10
}
// 変数参照
api_url = "https://"${database.host}":8080"
```
```bash
$ hocon2json app.conf
{
"api_url": "https://localhost:8080",
"database": {
"host": "localhost",
"pool_size": 10,
"port": 5432
}
}
```
## ビルド
```bash
make all # vet + test + build
make build # ビルドのみ
make test # テストのみ
make install # 全バイナリをインストール
```
## 関連プロジェクト
| プロジェクト | 言語 | レジストリ | 説明 |
|---------|----------|----------|-------------|
| [go.hocon](https://github.com/o3co/go.hocon) | Go | [pkg.go.dev](https://pkg.go.dev/github.com/o3co/go.hocon) | Go 向け HOCON パーサー（本プロジェクトで使用） |
| [ts.hocon](https://github.com/o3co/ts.hocon) | TypeScript | [npm](https://www.npmjs.com/package/@o3co/ts.hocon) | TypeScript/Node.js 向け HOCON パーサー |
| [rs.hocon](https://github.com/o3co/rs.hocon) | Rust | [crates.io](https://crates.io/crates/o3co-hocon) | Rust 向け HOCON パーサー |
すべての実装が Lightbend HOCON 仕様に完全準拠しています。
## ベストプラクティス
### CI/CD 統合
- CI パイプラインでデプロイ前に `hocon2json -validate` で HOCON の構文をチェックしましょう
- `-env-file` を使えばシェル環境を汚さずに環境別変数を注入できます
### CI での設定バリデーション
```yaml
# 例: GitHub Actions
- name: Validate config
run: hocon2json -validate config/prod.conf
```
### 複数ファイルのマージ
- マージ順序が重要: 後のファイルが前のファイルを上書きします
- `base.conf` + `env.conf` パターンで環境別のオーバーライドを行いましょう:
```bash
hocon2json base.conf prod.conf > config.json
```
## ライセンス
Apache 2.0 — [LICENSE](LICENSE) を参照。