diff --git a/.gitignore b/.gitignore index 03ddd82..61f466d 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ node_modules # output out dist +bin *.tgz # generated code diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4b9c274 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 simochee + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/src/content/docs/getting-started/installation.md b/docs/src/content/docs/getting-started/installation.md index 1e6b81f..880f8cb 100644 --- a/docs/src/content/docs/getting-started/installation.md +++ b/docs/src/content/docs/getting-started/installation.md @@ -3,24 +3,32 @@ title: インストール description: Backlog CLI のインストール方法 --- -## 前提条件 - -Backlog CLI の実行には [Bun](https://bun.sh/) ランタイムが必要です。 +## npm ```bash -curl -fsSL https://bun.sh/install | bash +npm install -g @simochee/backlog-cli ``` -## インストール +### パッケージマネージャーごとのインストール ```bash +# npm +npm install -g @simochee/backlog-cli + +# yarn +yarn global add @simochee/backlog-cli + +# pnpm +pnpm add -g @simochee/backlog-cli + +# bun bun install -g @simochee/backlog-cli ``` ## アップデート ```bash -bun install -g @simochee/backlog-cli@latest +npm install -g @simochee/backlog-cli@latest ``` ## バージョン確認 diff --git a/package.json b/package.json index 19127d9..adde873 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,10 @@ { "private": true, + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/simochee/backlog-cli.git" + }, "workspaces": [ "packages/*", "docs" diff --git a/packages/cli/README.md b/packages/cli/README.md index 10cd75f..b811d9a 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,15 +1,91 @@ -# backlog-cli +# @simochee/backlog-cli -To install dependencies: +[Backlog](https://backlog.com/) をコマンドラインから操作するための CLI ツールです。[GitHub CLI (gh)](https://cli.github.com/) のインターフェースを参考に設計されています。 + +## インストール + +```bash +npm install -g @simochee/backlog-cli +``` + +## クイックスタート + +### 認証 + +まず Backlog スペースに認証します。 + +```bash +backlog auth login +``` + +対話形式でホスト名と認証方式を選択できます。API キーを使う場合は以下のように指定します。 + +```bash +backlog auth login --hostname your-space.backlog.com --method api-key +``` + +### 基本操作 ```bash -bun install +# 課題の一覧 +backlog issue list --project YOUR_PROJECT + +# 課題の作成 +backlog issue create --project YOUR_PROJECT --title "新しい課題" --type バグ --priority 高 + +# 課題の詳細 +backlog issue view PROJECT-123 + +# プロジェクトの一覧 +backlog project list + +# 通知の確認 +backlog notification list + +# ダッシュボード +backlog status ``` -To run: +## コマンド一覧 + +| コマンド | 説明 | +|---|---| +| `backlog auth` | 認証の管理 | +| `backlog config` | CLI の設定管理 | +| `backlog issue` | 課題の操作 | +| `backlog pr` | プルリクエストの操作 | +| `backlog project` | プロジェクトの操作 | +| `backlog repo` | Git リポジトリの操作 | +| `backlog notification` | 通知の操作 | +| `backlog wiki` | Wiki の操作 | +| `backlog user` | ユーザーの操作 | +| `backlog team` | チームの操作 | +| `backlog category` | カテゴリーの操作 | +| `backlog milestone` | マイルストーンの操作 | +| `backlog issue-type` | 種別の操作 | +| `backlog status-type` | 状態の操作 | +| `backlog space` | スペースの操作 | +| `backlog webhook` | Webhook の操作 | +| `backlog star` | スターの操作 | +| `backlog watching` | ウォッチの操作 | +| `backlog alias` | エイリアスの操作 | +| `backlog status` | ダッシュボードの表示 | +| `backlog browse` | ブラウザで開く | +| `backlog api` | Backlog API の直接呼び出し | +| `backlog completion` | シェル補完スクリプトの生成 | + +## 出力形式 + +デフォルトではテーブル形式で出力されます。JSON 形式で取得する場合は `--json` フラグを使用します。 ```bash -bun run index.ts +backlog issue list --project YOUR_PROJECT --json ``` -This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime. +## ドキュメント + +詳細なドキュメントは https://simochee.github.io/backlog-cli を参照してください。 + +## ライセンス + +[MIT](../../LICENSE) diff --git a/packages/cli/package.json b/packages/cli/package.json index 84298ce..c36c283 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,13 +1,39 @@ { "name": "@simochee/backlog-cli", - "private": true, + "version": "0.0.0", + "description": "Backlog CLI — manage Backlog from the command line", "type": "module", + "license": "MIT", + "author": "simochee", + "homepage": "https://simochee.github.io/backlog-cli", + "repository": { + "type": "git", + "url": "https://github.com/simochee/backlog-cli.git", + "directory": "packages/cli" + }, + "bugs": { + "url": "https://github.com/simochee/backlog-cli/issues" + }, + "keywords": [ + "backlog", + "cli", + "nulab", + "project-management" + ], + "bin": { + "backlog": "./bin/backlog.mjs" + }, + "files": [ + "bin" + ], "imports": { "#*": "./src/*" }, "scripts": { - "build": "bun build ./src/index.ts --compile --outfile ./out/$npm_package_name", + "build": "bun build ./src/index.ts --outfile ./bin/backlog.mjs --target=node", + "build:compile": "bun build ./src/index.ts --compile --outfile ./out/$npm_package_name", "dev": "bun ./src/index.ts", + "prepublishOnly": "bun run build", "test": "vitest run" }, "dependencies": {