diff --git a/README.md b/README.md index 6c20e58..d902da6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # ppv26-cli +[![CI](https://github.com/F88/ppv26-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/F88/ppv26-cli/actions/workflows/ci.yml) +[![CodeQL](https://github.com/F88/ppv26-cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/F88/ppv26-cli/actions/workflows/github-code-scanning/codeql) +[![GitHub Advanced Security](https://github.com/F88/ppv26-cli/actions/workflows/agents/github-advanced-security/badge.svg)](https://github.com/F88/ppv26-cli/actions/workflows/agents/github-advanced-security) + +[![npm version](https://badge.fury.io/js/ppv26-cli.svg?icon=si%3Anpm)](https://badge.fury.io/js/ppv26-cli) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +![Issues](https://img.shields.io/github/issues/F88/ppv26-cli?label=issues) + +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/F88/ppv26-cli) +[![View Code Wiki](https://www.gstatic.com/_/boq-sdlc-agents-ui/_/r/YUi5dj2UWvE.svg)](https://codewiki.google/github.com/f88/ppv26-cli) + ProtoPedia Viewer CLI tools - inspect ProtoPedia API data offline, from local snapshots. ## Overview @@ -47,9 +58,9 @@ ppv-cli snapshot create Now the data is ready - explore it any way you like: ```console -ppv-cli prototype list # one-shot, pipe-friendly -ppex # interactive explorer -pptop # top(1)-style monitor +ppex # interactive explorer +pptop # top(1)-style monitor +ppv-cli prototype show 1 # one work as JSON ``` > A token is only required for `snapshot create`. Starting `pptop` / `ppex` before a token and a snapshot exist just shows a setup hint, so run steps 2-3 first. @@ -63,7 +74,7 @@ Uninstall with `npm uninstall -g ppv26-cli`. A pipe-friendly, UNIX-like CLI: one command per invocation, results on stdout (JSON or tab-separated), logs on stderr. Run `ppv-cli --help` for the command list. ```console -ppv-cli prototype search --tag M5Stack # facet search +ppv-cli config show # settings and config file path ppv-cli prototype show 1234 # one work as JSON ``` @@ -87,7 +98,7 @@ node dist/pptop.js # from a source clone ## Configuration -The settings live in a single file under your home directory: `~/.ppv-cli/config` on macOS / Linux, `%USERPROFILE%\.ppv-cli\config` on Windows. +The settings live in a single file under your home directory: `~/.ppv-cli/config` on macOS / Linux, `%USERPROFILE%\.ppv-cli\config` on Windows. Run `ppv-cli config show` to print the exact path on your system, along with the current settings (the token is masked). This file (KEY=VALUE format) is the single source of truth for every setting, the API token included - no .env files and no environment-variable overrides. One-shot overrides are the CLI options (`--snapshot`, `--snapshot-dir`, `--verbose` / `--quiet`). Keys: diff --git a/docs/images/ppex-1.png b/docs/images/ppex-1.png new file mode 100644 index 0000000..cb71cd8 Binary files /dev/null and b/docs/images/ppex-1.png differ diff --git a/docs/images/pptop-1.png b/docs/images/pptop-1.png new file mode 100644 index 0000000..b98c571 Binary files /dev/null and b/docs/images/pptop-1.png differ diff --git a/docs/images/pptop-2.png b/docs/images/pptop-2.png new file mode 100644 index 0000000..516737f Binary files /dev/null and b/docs/images/pptop-2.png differ diff --git a/docs/overview.ja.md b/docs/overview.ja.md new file mode 100644 index 0000000..2e57476 --- /dev/null +++ b/docs/overview.ja.md @@ -0,0 +1,59 @@ +# 作品概要 + +## Title + +ProtoPedia Viewer CLI tools + +## Summary (100) + +CLIでもProtoPediaを探索。作品のメタデータ確認や調査が捗るかもしれません。基本的には開発者向きのツールです。 + +## Story (2000) + +APIを利用するアプリケーションの開発では、調査、デバッグなど、頻繁なデータ探索が不可欠。とはいえ毎回APIを叩くのはお行儀も悪く非効率、NW障害などの障害耐性も低い。 + +我々のために、調査、開発を助けるツールがあればなにかと便利なはず、MCPサーバーまで登場したこの時代にAIフリーなツールです。 + +### 概要 + +ProtoPedia API Ver 2.0 を使ってアプリケーションを開発する開発者向けのツール群です。取得したデータをローカルのsnapshotとして保存し、フィールド値・raw JSON・件数といった実データをオフラインで検索・絞り込み・調査できます。 +調査の為に毎回APIを叩かずに済むので、開発者の作業効率が上がるかもしれません。 + +### 3つのツール + +- pptop: top(1) スタイルの作品モニター。集計ヘッダとソート・フィルタ可能なテーブル。 +- ppex: インタラクティブな探索ツール (ProtoPedia EXplorer)。 +- ppv-cli: ワンショットでパイプしやすい UNIX 風 CLI。結果は stdout (JSON またはタブ区切り)、ログは stderr + +### 動作環境 + +- Node.js 22 以上 +- ProtoPedia API Ver 2.0 トークン + +### クイックガイド + +インストール + +```shell +npm install -g ppv26-cli +``` + +API トークンを設定 + +```shell +ppv-cli config set-token +``` + +スナップショット作成 (APIアクセス) + +```shell +ppv-cli snapshot create +``` + +あとはオフラインで即座に利用出来ます。 + +```text +ppex # 対話型の探索ツール +pptop # top(1) 風モニター +ppv-cli prototype show 1 # 1 作品を JSON で表示 +```