ドライバー

このドキュメントは自動生成されています。手動で編集しないでください。

生成コマンド: go run scripts/gen-docs.go

LocalFsConfig

LocalFsConfig はローカルファイルシステムの設定

ファイル: local.go

パラメータ	型	必須	デフォルト	説明
root	string		.	ルートディレクトリ。このパスより上位には遡れない
transform	string		json	読み込み時の変換方法（dotenv, json など）

設定例:

localfs:
  driver: local
  args:
    root: ./config
    transform: dotenv

S3FsConfig

S3FsConfig は S3 ファイルシステムの設定

ファイル: s3.go

パラメータ	型	必須	デフォルト	説明
bucket	string	✓	-	S3 バケット名
region	string	✓	-	AWS リージョン
access_key_id	string	✓	-	AWS アクセスキー ID
secret_access_key	string	✓	-	AWS シークレットアクセスキー
session_token	string		-	AWS セッショントークン（一時的な認証情報使用時）
endpoint	string		-	カスタムエンドポイント（MinIO など S3 互換ストレージ用）
use_path_style	bool		false	パススタイルアクセスを使用（S3 互換ストレージで必要な場合あり）
transform	string		-	読み込み時の変換方法（dotenv, json など）

設定例:

s3fs:
  driver: s3
  args:
    bucket: my-config-bucket
    region: ap-northeast-1
    access_key_id: AKIAIOSFODNN7EXAMPLE
    secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
    session_token: FwoGZXIvYXdzE...
    endpoint: http://localhost:9000
    use_path_style: true
    transform: dotenv

VaultConfig

VaultConfig は HashiCorp Vault ファイルシステムの設定

ファイル: vault.go

パラメータ	型	必須	デフォルト	説明
addr	string	✓	-	Vault サーバーのアドレス
token	string	✓	-	Vault 認証トークン
namespace	string		-	Vault 名前空間（Enterprise 機能）
mount	string	✓	secret	KV シークレットエンジンのマウントパス
kv_ver	int		2	KV シークレットエンジンのバージョン（現在は 2 のみサポート）
version	int		0	取得するシークレットのバージョン（0 = 最新）
field	string		-	取得する特定のフィールド名（省略時は全フィールド）
pretty	bool		false	JSON 出力を整形するか

設定例:

vault:
  driver: vault
  args:
    addr: http://localhost:8200
    token: root
    namespace: admin
    mount: secret

RestFsConfig

RestFsConfig は REST ファイルシステムの設定

ファイル: rest.go

パラメータ	型	必須	デフォルト	説明
base_url	string	✓	-	ベース URL
auth_type	string		-	認証タイプ（bearer, basic）
token	string		-	Bearer トークン
token_file	string		-	Bearer トークンファイルパス
username	string		-	Basic 認証ユーザー名
password	string		-	Basic 認証パスワード
ca_file	string		-	CA 証明書ファイルパス
insecure	bool		false	TLS 証明書検証をスキップ

設定例:

restfs:
  driver: rest
  args:
    base_url: https://api.example.com
    auth_type: bearer
    token_file: /var/run/secrets/token

DbFsConfig

DbFsConfig はデータベースファイルシステムの設定

ファイル: db.go

パラメータ	型	必須	デフォルト	説明
connection_string	string	✓	-	データベース接続文字列
driver	string		-	データベースドライバー（postgres, mysql, sqlite）。省略時は接続文字列から自動判定
query	string	✓	-	SQL クエリ。{key} と {namespace} がプレースホルダーとして使用可能
namespace	string		default	デフォルトの namespace 値

設定例:

dbfs:
  driver: db
  args:
    connection_string: postgres://user:pass@localhost/db
    query: SELECT value FROM config WHERE key = {key}
    namespace: production

NatsFsConfig

NatsFsConfig は NATS JetStream KV ファイルシステムの設定

ファイル: nats.go

パラメータ	型	必須	デフォルト	説明
url	string	✓	-	NATS サーバーの接続 URL
bucket	string	✓	-	JetStream KV バケット名
token	string		-	NATS 認証トークン
user	string		-	NATS ユーザー名
password	string		-	NATS パスワード
creds_file	string		-	NATS 認証情報ファイルパス

設定例:

natsfs:
  driver: nats
  args:
    url: nats://localhost:4222
    bucket: config

RedisFsConfig

RedisFsConfig は Redis ファイルシステムの設定

ファイル: redis.go

パラメータ	型	必須	デフォルト	説明
addr	string	✓	-	Redis サーバーのアドレス
password	string		-	Redis 認証パスワード
db	int		0	Redis データベース番号
prefix	string		-	キーのプレフィックス

設定例:

redisfs:
  driver: redis
  args:
    addr: localhost:6379
    db: 0
    prefix: config:

GitFsConfig

GitFsConfig は Git ファイルシステムの設定

ファイル: git.go

パラメータ	型	必須	デフォルト	説明
url	string	✓	-	Git リポジトリ URL
ref	string		main	ブランチまたはタグ名

設定例:

gitfs:
  driver: git
  args:
    url: https://github.com/example/config.git
    ref: main

EnvFsConfig

EnvFsConfig は環境変数ファイルシステムの設定

ファイル: env.go

パラメータ	型	必須	デフォルト	説明
include	[]string		-	許可する環境変数キーのリスト。未指定で全許可
exclude	[]string		-	除外する環境変数キーのリスト。include より優先

設定例:

envfs:
  driver: env
  args:
    include: APP_NAME,DATABASE_URL
    exclude: SECRET_KEY,PASSWORD

BitwardenFsConfig

BitwardenFsConfig は Bitwarden Secrets Manager ファイルシステムの設定

ファイル: bitwarden.go

パラメータ	型	必須	デフォルト	説明
access_token	string	✓	-	Bitwarden アクセストークン
organization_id	string	✓	-	Bitwarden 組織 ID
project_id	string		-	フィルタ対象のプロジェクト ID

設定例:

bitwardenfs:
  driver: bitwarden
  args:
    access_token: 0.48c78342-...
    organization_id: a1b2c3d4-...
    project_id: e325ea69-...

ToolFsConfig

ToolFsConfig は Tool ファイルシステムの設定設定パラメータは不要です。利用可能なパス: uuid7, uuid4, now, timestamp, random/hex/{bytes}, random/base64/{bytes}, password

ファイル: tool.go

Keyboard shortcuts

kvtool