dot-sk
v0.3.0
Published
dotfiles management CLI (git bare repo + age encryption)
Maintainers
tomoirisReadme
dot-sk
dotfiles管理CLIツール。git bare repo + age暗号化でdotfilesを安全にバージョン管理・同期する。
特徴
- git bare repo方式 --
$HOME直下のdotfilesをその場でgit管理 - age暗号化 -- SSH鍵で秘密ファイルを暗号化し、安全にリモートへ同期
- マルチプロファイル -- マシンごとにブランチ・同期方向を設定
- スナップショット -- 操作前に自動で状態を保存、いつでもロールバック可能
インストール
npm（推奨）
npm install -g dot-skローカルビルド
git clone https://github.com/TomoTom0/dot-sk.git
cd dot-sk
pnpm install
mise run install依存ツール
| ツール | 用途 | 必須 | |---|---|---| | Node.js >= 20 | ランタイム | Yes | | git | バージョン管理 | Yes | | age | ファイル暗号化 | 暗号化機能を使う場合 |
クイックスタート
# 初期化
dot-sk init [email protected]:you/sync-dot-sk.git
# 設定ファイルを編集
# ~/.config/dot-sk/config.toml にプロファイル・ファイル・暗号化鍵を設定
# 保存してプッシュ
dot-sk save "initial commit"
dot-sk push
# 別マシンでクローン
dot-sk clone [email protected]:you/sync-dot-sk.git
dot-sk pull
dot-sk load主なコマンド
| コマンド | 説明 |
|---|---|
| dot-sk init | bare repoを初期化 |
| dot-sk clone | リモートからbare repoをclone |
| dot-sk save | プロファイルの全ファイルをコミット |
| dot-sk push | リモートへプッシュ |
| dot-sk pull | リモートから取得して展開 |
| dot-sk load | 暗号化ファイルを復号して展開 |
| dot-sk merge | 別ブランチからファイルをマージ |
| dot-sk snapshot | スナップショットの作成・一覧・ロールバック |
| dot-sk status | 変更状態を表示 |
| dot-sk profile | 現在のプロファイル情報を表示 |
| dot-sk docs | 使い方ガイドを表示 |
詳しい使い方は dot-sk docs または docs/usage.md を参照。
ライセンス
サードパーティ
このツールは以下のライブラリを使用しています: THIRD-PARTY-NOTICES.md