Skip to content

immmmmmmu/plsnt

BranchesTags

Repository files navigation

plsnt — Pleasanter CLI Tool

エージェントファーストの Pleasanter REST API クライアント。 AI エージェント（Claude Code 等）との連携を第一に設計された CLI ツールです。

plsnt record list --site-id 100 -o json    # レコード一覧（JSON）
plsnt site create --parent-id 1 --json '{...}'  # サイト作成
plsnt batch run template.yaml              # バッチ実行
plsnt workflow deploy --template full-deploy --folder-id 100  # ワークフロー構築

特徴

  • エージェントファースト: TTY 自動検出、--json RAW ペイロード、スキーマ自己参照
  • Pleasanter MCP 共存: MCP で対話的探索、CLI で自動化の ハイブリッド運用
  • バッチエンジン: YAML テンプレートで複数テーブルの一括構築
  • ワークフロー: 申請・承認フローアプリを workflow deploy 一発で構築
  • 構成差分監査: Web UI でエクスポートした SitePackage JSON 同士を plsnt site diff で意味的に比較（API 不要）
  • スキル同梱・クロスエージェント: Pleasanter 操作の知見（Core 11 スキル）を plsnt init で任意のエージェント（Claude Code / Codex / Gemini）へ展開

インストール

どちらを選ぶか

利用形態 推奨
scripts/ / templates/ の業務サンプルも直接使いたい開発者向け A. ソースから
MCP サーバーとして Claude Desktop の通常チャットから使うだけ（CLI 単体利用） B. バイナリ
CI / 本番サーバで非対話的に実行 B. バイナリ
Go 未インストール・非エンジニア B. バイナリ

スキル（Pleasanter 操作の知見集）は どちらの方法でも plsnt init で導入できます（バイナリに同梱）。 A（ソース）が必要なのは、scripts/ や templates/ の業務サンプルを直接参照したい場合だけです。

A. ソースからビルド（推奨）

git clone https://github.com/immmmmmmu/plsnt.git
cd plsnt
go build -ldflags="-s -w" -o plsnt .

Windows 向けクロスビルド（WSL / Linux から）:

GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build -ldflags="-s -w" -o plsnt.exe .

Windows ネイティブビルド（PowerShell、Go 1.25+ が必要）:

git clone https://github.com/immmmmmmu/plsnt.git C:\dev\plsnt
cd C:\dev\plsnt
go build -ldflags="-s -w" -o plsnt.exe .
# 任意で PATH に追加
Move-Item plsnt.exe C:\tools\plsnt\plsnt.exe

Go 1.25 以上が必要です。winget install GoLang.Go で 5 分。

B. ビルド済みバイナリ

Releases から OS/アーキテクチャに合ったバイナリをダウンロード。

Linux / macOS:

tar xzf plsnt_*_linux_amd64.tar.gz
sudo mv plsnt /usr/local/bin/

Windows (PowerShell):

Expand-Archive plsnt_*_windows_amd64.zip -DestinationPath C:\tools\plsnt
$env:Path += ";C:\tools\plsnt"

初期設定

# プロファイル作成
plsnt config set --url https://your-pleasanter.example.com --api-key YOUR_API_KEY

# 接続テスト
plsnt config test

# MCP 接続設定の自動生成（Pleasanter 1.5+）
plsnt config mcp-setup --output .mcp.json

設定ファイルは次の場所に保存されます（APIキーは平文、chmod 600 相当で保護）:

OS パス
Linux / macOS ~/.config/plsnt/config.yaml
Windows %USERPROFILE%\.config\plsnt\config.yaml

スキルの導入（plsnt init）

plsnt init で Core スキル一式を任意のプロジェクトへ展開できます。スキルは素の Markdown なので、 Claude Code 専用ではなく 任意の AI エージェントアプリで知識として利用できます。

# 対話モード（配置先・エージェント・接続先を順に質問）
plsnt init

# 非対話（CI など）: Codex 向けに .codex/skills を生成し、プロファイルと .mcp.json も作成
plsnt init --yes --agent codex \
  --url https://your-pleasanter.example.com --api-key YOUR_KEY --mcp

同梱される Core セットは以下です（CLI 操作・テーブル設計・データ移行・MCP 接続など）:

  • スキル 11（汎用リファレンス）
  • 連動するサブエージェント 5（pleasanter-api-expert / site-builder / data-migrator / report-generator / integrity-checker）
  • 連動するコマンド 5（site-build / migrate-data / generate-report / check-integrity / seed-data）
  • ルール 1（domain-glossary — Pleasanter 用語集）

他のエージェントアプリで使う (Cross-Agent Usage)

スキルとルールの中身はツール非依存です。差異は「配置先と起動方法」だけで、plsnt CLI が PATH にあれば どのエージェントからでも同じパターンを再現できます。サブエージェント・コマンドは Claude Code 固有の仕組みのため、他エージェントには展開しません（スキル＋ルールのみを畳み込み）。

エージェント 展開される内容 配置先 --agent
Claude Code スキル + サブエージェント + コマンド + ルール .claude/{skills,agents,commands,rules}/ claude（既定）
OpenAI Codex スキル + ルール .codex/skills/<name>/SKILL.md（ネイティブ）、AGENTS.md に小さなブートストラップ codex
Gemini CLI スキル + ルール GEMINI.md に集約 gemini
Cursor / Windsurf / 汎用 スキル + ルール AGENTS.md を直接コンテキストへ generic

--scope project（既定, ./）か --scope user（~/）で配置先のルートを切り替えます。 Codex の AGENTS.md は durable なブートストラップのみで、スキル本体は .codex/skills/ を使います。 AGENTS.md / GEMINI.md への書き出しは既存内容を保持し、<!-- BEGIN plsnt skills --> 〜 <!-- END plsnt skills --> のブロックだけを更新するため、再実行しても重複しません。

Windows での Claude Desktop 連携

Claude Desktop から plsnt を MCP サーバーとして利用する場合:

  1. plsnt.exe を C:\tools\plsnt\ などに配置
  2. PowerShell で接続設定: 
    C:\tools\plsnt\plsnt.exe config set --url http://your-pleasanter --api-key YOUR_KEY
C:\tools\plsnt\plsnt.exe config test
  3. %APPDATA%\Claude\claude_desktop_config.json に追加: 
    {
  "mcpServers": {
    "plsnt": {
      "command": "C:\\tools\\plsnt\\plsnt.exe",
      "args": ["mcp", "serve"]
    }
  }
}
  4. Claude Desktop を再起動

Claude Code 等でスキルを使う

スキルはリポジトリには同梱されていません。plsnt init で導入してください（上記「スキルの導入」を参照）。

cd C:\dev\your-project
plsnt init --agent claude   # .claude/skills/ に Core 11 スキルを展開

注意: ソース同梱の業務サンプル（scripts/*.sh）を実行するには、Windows では Git Bash（Git for Windows に付属） または WSL が必要です。

クイックスタート

レコード操作

# 一覧取得
plsnt record list --site-id 100

# フィルタ・ソート
plsnt record list --site-id 100 \
  --view '{"ColumnFilterHash":{"ClassA":"Red"},"ColumnSorterHash":{"Title":"asc"}}'

# 作成
plsnt record create --site-id 100 --json '{"Title":"新規","ClassHash":{"ClassA":"A"}}'

# 更新
plsnt record update 12345 --json '{"Title":"更新後"}'

# 一括 Upsert
plsnt record upsert --site-id 100 --keys ClassA --json '[...]'

サイト管理

plsnt site get 100                          # サイト情報
plsnt site create --parent-id 1 --json '{...}'  # 作成
plsnt schema 100 -o table                   # カラム定義確認

バッチ実行

plsnt batch run template.yaml               # テンプレート展開
plsnt batch run template.yaml --dry-run     # ドライラン
plsnt batch run template.yaml --var key=val # 変数上書き

ワークフロー（申請・承認アプリ）

# テーブル一括構築（8テーブル + リンク）
plsnt workflow deploy --template full-deploy --folder-id 12345

# マスタデータ投入
plsnt workflow master --site-id 32630 --file departments.csv

# 承認済み申請の CSV エクスポート
plsnt workflow export --header-site-id 32635 --detail-site-id 32636 \
  --from 2026-04-01 --to 2026-04-30

出力フォーマット

フォーマット 用途
json（デフォルト） エージェント連携、プログラム処理
table ターミナル確認
csv Excel、他ツール連携
ndjson ストリーム処理、パイプ
count 件数確認
ids スクリプト連携 
plsnt record list --site-id 100 -o csv > records.csv
plsnt record list --site-id 100 -o ndjson | jq '.ClassHash.ClassA'

コマンド一覧

plsnt init                                  Core スキル導入（任意エージェント対応）
plsnt config set/list/use/test/mcp-setup   プロファイル管理
plsnt record get/list/create/update/delete  レコード CRUD
plsnt record upsert/import/bulk-delete      一括操作
plsnt site get/create/update/delete/copy    サイト管理
plsnt schema                                カラム定義表示
plsnt user/group/dept list/get/create/...   ユーザー・組織管理
plsnt access tables/export/import           Access DB 連携
plsnt migrate generate-mapping/execute      データ移行
plsnt batch run                             バッチ YAML 実行
plsnt workflow deploy/master/export         ワークフロー管理

MCP 共存（Pleasanter 1.5+）

3 つの経路があり、用途別にルーティングします:

用途 経路
スキル / エージェント連携の 既定（CRUD・バッチ・ワークフロー・サイト構築） plsnt MCP（plsnt mcp serve、20 ツール）
対話的探索・ビュー CRUD・メール送信・日本語列名自動変換 Pleasanter MCP（本家 1.5+、/mcp）
シェルスクリプト / CI / CD・大量データ・ユーザー/グループ/部署 CRUD plsnt CLI

設計判断の根拠と 20 ツール選定基準は ADR-0001 を、運用ガイドは USER_GUIDE_V2.md を参照してください。

ドキュメント

ドキュメント 対象
USER_GUIDE.md CLI 詳細リファレンス
USER_GUIDE_V2.md MCP + CLI + Claude Code 統合ガイド
ADR-0001 Pleasanter MCP と plsnt MCP の棲み分け（設計判断）
CONTEXT.md ワークフローアプリの構造説明（エージェント向け）
CLAUDE.md 開発者向けガイド

開発

go test ./...                    # 全テスト
go test -tags=integration ./...  # 統合テスト（実 Pleasanter 必要）
go test -cover ./...             # カバレッジ付き
golangci-lint run                # リント

開発元

株式会社HereNow

ライセンス

AGPL v3 - Pleasanter 本体と同じライセンス。

Copyright (C) 2026 株式会社HereNow

About

plsnt — agent-first CLI for Pleasanter REST API operations (Go)

Resources

Readme

License

AGPL-3.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 2

v0.2.0 Latest
Jun 4, 2026
+ 1 release

Packages

 
 
 

Contributors

Languages