@nazozokc/orbase
v0.9.0
Published
[](https://github.com/nazozokc/orbase/actions/workflows/publish.yml)<br> タスク・メモ・日記を CLI から管理する個人用ライフ管理ツール。
Downloads
2,303
Readme
orbase
タスク・メモ・日記を CLI から管理する個人用ライフ管理ツール。
すべてのデータはローカルの ~/.orbase/ にプレーンテキスト形式で保存される。エディタで直接編集することもできる。
特徴
- タスク管理 — タスクの追加・編集・削除・一覧表示(優先度・状態フィルタ付き)
- メモ管理 — 本棚(book)ごとに Markdown 形式のメモを追加・編集・削除
- 日記 — 日付ごとの Markdown 日記を作成・編集・削除
- タグ — タスク・メモにタグを付け、タグで横断検索
- 検索 — キーワード / タグでタスク・メモ・日記を横断検索
- カレンダー — 指定した年月のカレンダーをターミナルに表示
- テンプレート — よく使うファイルやディレクトリをカレントディレクトリへコピー
- 初期設定 — orbase の設定ファイルを作成
- エディタ連携 — 編集は
$EDITORでファイルを直接開く - データは全てローカル —
~/.orbase/配下に JSON / Markdown で保存
インストール
npm / Bun
Node.js 22 以上が必要。
npm install -g @nazozokc/orbase
# または
bun add -g @nazozokc/orbaseNix flake
# 一時的に実行
nix run github:nazozokc/orbase
# プロファイルへインストール
nix profile install github:nazozokc/orbase使い方
orbase <command> [subcommand] [arguments]主なコマンドは次のとおり。
| コマンド | 説明 |
| :------------------------------- | :------------------------------------------------- |
| orbase task | タスクを管理 |
| orbase note | 本棚ごとのメモを管理 |
| orbase diary | 日記を管理 |
| orbase search | タスク・メモ・日記を検索 |
| orbase calendar <year> <month> | 指定した年月のカレンダーを表示 |
| orbase template <name> | 登録したテンプレートをカレントディレクトリへコピー |
| orbase init | 設定ファイルを作成 |
メモや日記の編集には環境変数 $EDITOR に設定されたエディタが使われる。未設定の場合は、利用するエディタを設定してから実行する。
export EDITOR=vim
orbase note addtask — タスク管理
タスクは ~/.orbase/task/*.json に保存される。
| コマンド | 説明 |
| :--------------------- | :------------------------------------------------------------- |
| orbase task add | タスクを追加(見出し・本文・期限・優先度・タグを対話的に入力) |
| orbase task edit | タスクを選択して項目を対話的に編集 |
| orbase task del | タスクを選択して削除 |
| orbase task list | タスク一覧をテーブル表示 |
| orbase task priority | 優先度でタスクをフィルタして表示 |
| orbase task status | 状態でタスクをフィルタして表示 |
$ orbase task add
? task title 買い物
? task detail 牛乳と卵を買う
? goal date 2026-08-21
? Select priority Medium
? create or select? create
? create and select tags 買い物
$ orbase task list
┌───────┬──────────────────┬────────────┬────────┬──────────┬──────┐
│ title │ detail │ dueDate │ tag │ priority │ status │
├───────┼──────────────────┼────────────┼────────┼──────────┼──────┤
│ 買い物 │ 牛乳と卵を買う │ 2026-08-21 │ 買い物 │ medium │ todo │
└───────┴──────────────────┴────────────┴────────┴──────────┴──────┘タグは作成済みのタグから選ぶこともできる。
note — メモ管理
メモは本棚ごとのディレクトリに、front matter(date / tags)付きの Markdown として ~/.orbase/note/<book>/*.md に保存される。
| コマンド | 説明 |
| :----------------- | :--------------------------------------------- |
| orbase note add | ファイル名を入力してメモを作成しエディタで開く |
| orbase note edit | メモを選択してエディタで編集 |
| orbase note del | メモを複数選択して削除 |
diary — 日記
日記は ~/.orbase/diary/YYYY/MM/YYYY-MM-DD.md に保存される。
| コマンド | 説明 |
| :------------------ | :------------------------------- |
| orbase diary add | 今日の日記を作成しエディタで開く |
| orbase diary edit | 年・月・日を入力して日記を編集 |
| orbase diary del | 年・月・日を入力して日記を削除 |
$ orbase diary add
# ~/.orbase/diary/2026/08/2026-08-20.md がエディタで開くsearch — 横断検索
キーワードまたはタグでタスク・メモ・日記を検索して表示する。
| コマンド | 説明 |
| :------------------------------- | :----------------------------------------- |
| orbase search string <keyword> | タスク・メモ・日記を横断してキーワード検索 |
| orbase search tags <tag> | タグが一致するタスク・メモのパスを表示 |
$ orbase search string 牛乳
/home/user/.orbase/note/personal/買い物.md
# 牛乳と卵を買う
$ orbase search tags 買い物
/home/user/.orbase/task/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.json
/home/user/.orbase/note/personal/買い物.mdcalendar — カレンダー表示
指定した年月のカレンダーをターミナルのテーブルとして表示する。
orbase calendar <year> <month>$ orbase calendar 2026 9
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
│ Sun │ Mon │ Tue │ Wed │ Thu │ Fri │ Sat │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ │ │ 1 │ 2 │ 3 │ 4 │ 5 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ 13 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ 20 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 │
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ 27 │ 28 │ 29 │ 30 │ │ │ │
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘template — テンプレートの再利用
よく使うファイルやディレクトリをあらかじめ ~/.orbase/template/ にテンプレートとして登録しておくと、名前を指定してカレントディレクトリへコピーできる。同じ構成のファイルを複数のプロジェクトで使い回したい場合に利用する。
orbase template projectテンプレート名は ~/.orbase/template/ 配下のファイルまたはディレクトリ名です。テンプレートはあらかじめ手動で配置してください。
init — 初期設定
~/.config/orbase/config.json に既定の設定ファイルを作成します。データ保存先を変更する場合は、最初に実行してください。
orbase initヘルプ / バージョン
orbase --help
orbase --versionデータの保存場所
すべてのデータは ~/.orbase/ 配下に保存される。
設定ファイルは ~/.config/orbase/config.json に保存される。
~/.orbase/
├── task/ # タスク (JSON)
│ └── <uuid>.json
├── note/ # メモ (Markdown + front matter)
│ └── <book>/
│ └── <name>.md
├── diary/ # 日記 (Markdown)
│ └── YYYY/
│ └── MM/
│ └── YYYY-MM-DD.md
├── template/ # テンプレート(任意)
├── tags.json # タグ一覧 (JSON)
└── book.json # 本棚名 (JSON)タスクの JSON は以下の形式。
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"title": "買い物",
"detail": "牛乳と卵を買う",
"dueDate": "2026-08-21",
"priority": "Medium",
"tag": ["買い物"],
"status": "Todo",
"createdAt": "2026-08-20T04:00:00.000Z"
}メモは本棚ディレクトリ内に保存され、gray-matter 形式の front matter を持つ。
---
date: "2026-8-20"
tags:
- 買い物
---
# 本文開発
Nix flake の devShell を使う。direnv を導入していればリポジトリに入るだけで環境が整う。
# direnv を有効化(初回のみ)
direnv allow
# 依存関係のインストール
bun install
# 依存を変更したら bun.nix を再生成(Nix ビルド用)
# bun.nix はリポジトリルートに置く(bun2nix は workspace パッケージを bun.nix からの相対パスで参照する)
cd .. && bun2nix -l bun.lock -o bun.nix
# ビルド (apps/orbase/dist/index.mjs を生成)
bun run --cwd apps/orbase build
# ローカルで実行
bun run apps/orbase/src/index.ts --help
# フォーマット / チェック
nix fmt
nix flake checkbun2nix は devShell に同梱されている。bun.nix を再生成したら nix build で動作確認すること。
テストは bun test で実行する。
パッケージ単体で開発する場合は apps/orbase で次のように実行できる。
cd apps/orbase
bun run src/index.ts --helpLicense
MIT
