OSF CLI Go

osf-cli-go

Open Science Framework（OSF）用の Go コマンドラインクライアントです。

特長

• osf auth whoami — 認証済みの OSF アカウントを確認
• osf auth login — ユーザー名とパスワードを使うユーザー向けに、パーソナルアクセストークンの初期設定をガイド
• osf projects list|get — プロジェクトの一覧表示と詳細確認
• osf components list — プロジェクトコンポーネントを一覧表示
• osf files list|download|upload|mkdir|rm — OSF Storage ファイルの閲覧、ダウンロード、アップロード、フォルダー作成、削除
• osf search、osf search --bibtex、osf preprints list|search、osf resolve — OSF の文献メタデータの検索・エクスポート、プレプリントの検索、OSF DOI のリンク先の解決
• osf registrations create — 既存のノードにドラフト登録を作成
• osf export — ノードのスナップショットを JSON または要約テーブルとしてエクスポート
• osf validate — 決定論的な研究成果または事前登録のプロファイルを使って OSF ノードのメタデータを検証
• osf-mcp — エージェントクライアント向けに読み取り専用の OSF ツールを公開する、標準入出力対応の MCP サーバー
• osf completion bash|zsh|fish|powershell — シェル補完スクリプト
• JSON と人が読みやすい形式の出力モード
• 競合ポリシー（失敗／スキップ／上書き）に対応した、安全でアトミックなファイルダウンロード

インストール

要件：

• Go 1.26 以降

go install github.com/edithatogo/osf-cli-go/cmd/osf@latest
go install github.com/edithatogo/osf-cli-go/cmd/osf-mcp@latest

または、ローカルのチェックアウトからインストールします：

go build -o bin\osf.exe ./cmd/osf
go build -o bin\osf-mcp.exe ./cmd/osf-mcp
.\scripts\build.ps1

認証

シェルセッションで OSF_TOKEN を設定します。トークンをコミットしたり、プロジェクトファイルに書き込んだりしないでください。OSF_USERNAME と OSF_PASSWORD は、明示的に選択できる代替の認証情報としてサポートされています。ただし、自動化や SSO または二要素認証を使用するアカウントでは、引き続きパーソナルアクセストークンが推奨されます。

$env:OSF_TOKEN = '<your-token>'

トークン設定のガイドを利用するには：

osf auth login

クイックスタート

osf --help
osf auth whoami
osf projects list
osf projects get https://osf.io/abc12/
osf components list abc12
osf files list abc12
osf files download --file <file-id> ./output/
osf files download --tree abc12 ./output/
osf files upload --node abc12 ./report.pdf
osf search "open science"
osf search "open science" --bibtex
osf preprints list
osf preprints search "open science" --provider osf
osf resolve 10.1234/example
osf registrations create abc12 --schema <schema-id> --title "Analysis plan"
osf export abc12 --json

MCP サーバー

osf-mcp は、読み取り専用ツールを備えた stdio MCP サーバーを実行します。 osf_whoami、osf_projects_list、osf_project_get、 osf_components_list、osf_files_list、osf_contributors_list、 osf_search、osf_preprints_list、osf_preprints_search、および osf_doi_resolve を利用できます。

パリティ検出ツールは、範囲が限定され、決定論的に動作します。osf_search には 空でないクエリが必要で、1 から 100 までの上限を指定できます。 osf_preprints_list では、プロバイダーを任意で指定でき、同じ範囲の上限を 指定できます。osf_preprints_search にはタイトルクエリが必要で、プロバイダーを 任意で指定できます。上限を 1 から 100 まで指定でき、出版日、出版済みの状態、 DOI、OSF の HTML URL を返します。これらのツールは、MCP サーバーを介して 構造化 JSON を返し、書き込み操作は一切行いません。

OSF の検索結果には、安定した ID、タイトル、概要、キーワード、年、URL が 含まれます。文献レビューのワークフローで決定論的な BibTeX レコードを出力するには、 osf search <query> --bibtex を使います。このコマンドは、投稿者名の解決や PDF の自動ダウンロードは行いません。

DataLad のワークフローでは、OSF CLI Go が、データセットの周辺で使用する 汎用 OSF API と安全なファイル操作を提供します。これには osf export と osf files download --tree が含まれます。DataLad、Git リモート、 git-annex の特殊リモートのインストールや設定は行いません。これらの統合は、 引き続き別途定義された相互運用の範囲となります。

GitHub Copilot、VS Code、Claude、Codex、Gemini CLI、Qwen Code 向けの ローカル開発設定が含まれています。公開レジストリのメタデータは server.json と registry/ にあります。

関連する MCP サーバー

同じ Glama ポートフォリオで保守されている他のサーバー：

• FYI MCP：情報公開請求のワークフロー向けです。
• Healthpoint MCP：認可を受けた医療サービスのディレクトリデータ向けです。
• SourceRight：参考文献と引用の検証向けです。

OSF エコシステムの関連サーバー：

• pipeworx-io による OSF コネクター：ホスト型の OSF 接続向けです。
• Paperclip：複数プロバイダーに対応した学術文献および OSF Preprints の検索向けです。

出力モード

すべてのコマンドは --output table|json と省略形の --json をサポートしています：

osf projects list --json
osf auth whoami --output json

プロジェクトのステータス

この CLI は、読み取り専用操作、ファイルのダウンロード、WaterButler の書き込み プリミティブ、検索、プレプリントの一覧表示、下書き登録の作成、プロジェクトの 作成／更新／削除操作、ノードのエクスポートについて、オフラインでテスト済みです。 すべての Conductor トラックは、トラックごとの計画に照らしてクローズアウトレビューの 証拠とともに照合済みです。認証情報とネットワークアクセスが必要なため、OSF の ライブ検証はオプトイン方式のままです。

ドキュメント

• リリースチェックリスト
• ドキュメントサイトのソース
• インストールガイド
• 使用ガイド
• コマンドリファレンス
• 例
• アーキテクチャ
• 開発者ガイド
• MCP ロードマップ
• コントリビューション

ライセンス

Apache 2.0 — LICENSE を参照してください。

引用

このソフトウェアを研究で使用する場合は、CITATION.cff の メタデータを使って引用してください。