はじめに
Sidekick CLIはオープンソースのコマンドラインツールで、AIの支援により開発者のプロジェクト開発とデプロイプロセスを簡素化するように設計されています。以下によってサポートされています。 クロード コード、コパイロット カーソル Sidekick CLIは、Sidekick Language Modelにインスパイアされ、同様の機能を提供しますが、ベンダーロックインを避けるために、ユーザーがLarge Language Model (LLM)プロバイダーを自由に選択できるようにします。Sidekick CLIは、「CLI-first」設計で設計されており、AIインタラクション機能を拡張するためにModel Context Protocol (MCP)サーバーをサポートします。Sidekick CLIは、"CLI-first "設計で、AIインタラクション機能を拡張するモデルコンテキストプロトコル(MCP)サーバーをサポートしています。プロジェクトを素早く設定し、VPSにデプロイし、AIを通じてコード生成とデバッグのサポートを提供する、独立した開発者や小規模なチームに理想的です。このプロジェクトは現在ベータ版で、GitHubにホストされ、開発者のGavin Vickery (geekforbrains)によってMITライセンスの下で管理されており、コミュニティへの貢献やフィードバックを歓迎しています。
機能一覧
- AIによる開発支援複数のLLMプロバイダをサポートし、自然言語ヒントを使用して、コードの生成、問題のデバッグ、ドキュメントのクエリを実行できます。
- 柔軟なモデル切り替え同一セッション内で異なるAIモデルをシームレスに切り替え、異なるタスク要件に適応。
- MCPサーバーのサポートGitHubのコード検索など、AI機能を強化するために外部ツールやデータソースに接続します。
- プロジェクトのガイダンス文書スルー
SIDEKICK.md
プロジェクトのテクノロジー・スタックと開発環境をカスタマイズする。 - VPSワンクリック導入VPS環境の自動設定、DockerとTraefikのインストール、HTTPSドメインのサポート。
- 元に戻す使用
/undo
AIによる誤った変更を素早く元に戻す。 - コストとトークンのトラッキングLLMの使用コストとトークンの消費量を監視し、予算の上限を設定します。
- テレメトリーコントロールスルー
--no-telemetry
Sentryのバグ追跡と使用状況分析を無効にする。 - コマンド確認制御サポート
/yolo
Mode Skip Confirmation(モードをスキップして確認)を押すか、Session Adjustment(セッション調整)を押して設定を確定します。
ヘルプの使用
設置プロセス
SidekickのCLIはインストールが簡単で、以下の使用をサポートしています。 pip
またはソースコードのインストール。以下はその詳細な手順である:
- システム要件の確認
Python 3.8+ とpip
Windowsユーザーは、より良いターミナル体験のためにGit BashまたはWSLをインストールすることをお勧めします。 - pipによるインストール
以下のコマンドを実行し、Sidekick CLIをインストールしてください:pip install sidekick-cli
インストールが完了したら、バージョンを確認する:
sidekick --version
- ソースからのインストール(開発者向け)
GitHubリポジトリをクローンする:git clone https://github.com/geekforbrains/sidekick-cli.git cd sidekick-cli
依存関係をインストールします:
pip install .
開発モード(コードの変更がリアルタイムで反映される)が必要な場合は、実行する:
pip install -e .
- 初期設定
初めてSidekick CLIを実行します:sidekick
LLMプロバイダー(OpenAI、Anthropicなど)を設定するプロンプトが表示される。設定情報は
~/.config/sidekick.json
.設定例:{ "llm_providers": { "openai": { "api_key": "<你的API密钥>", "model": "gpt-4" } }, "mcpServers": { "fetch": { "command": "uvx", "args": ["mcp-server-fetch"] } } }
ファイルを手動で編集して、LLMプロバイダーを追加したり エムシーピー サーバー
- インストールの確認
以下のコマンドを実行し、Sidekick CLIが正常に動作していることを確認してください:sidekick --version
バージョン番号が返された場合(例えば
0.1.0
)、インストールは成功した。
機能操作ガイド
1.AIによる開発支援
Sidekick CLIの中核機能は、AIによる開発支援です。コードを生成するには、次のコマンドを実行します:
sidekick generate --prompt "编写一个 Flask REST API"
AIはプロンプトが表示されるとコードを生成し、指定されたファイルに保存します。コードをデバッグすることもできます:
sidekick debug --file app.py
このコマンドはコードを分析し、エラーを指摘して修正を提案する。AIの修正が問題を引き起こした場合は、アンドゥ機能を使うことができる:
sidekick /undo
Undoは最新の変更を復元し、素早くバグを修正するのに適しています。
2.柔軟なモデル切り替え
Sidekick CLIでは、セッション内でAIモデルを切り替えることができます。利用可能なモデルを表示します:
sidekick /model
出力例:
0: gpt-4 (OpenAI)
1: claude-3 (Anthropic)
特定のモデルに切り替える:
sidekick /model 0
この機能は、タスクの要件に応じて、より適切なモデルを選択するのに適しています。
3.MCPサーバーのサポート
MCPサーバーはSidekick CLIの機能を拡張します。例えば、GitHub MCPサーバーを設定してコードを取得します:
{
"mcpServers": {
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<你的GitHub令牌>"
}
}
}
}
保存後、以下のコマンドを実行してMCP機能をテストする:
sidekick fetch --repo <GitHub仓库地址>
MCPサーバーは、AIに外部データソースへの直接アクセスを提供し、コード生成と分析を強化する。
4.プロジェクトのガイダンス文書
SidekickのCLIは、以下の作成をサポートしています。 SIDEKICK.md
ファイルで、プロジェクトの技術スタックと開発環境設定を定義する。例 SIDEKICK.md
::
# Sidekick Guide
- Tech Stack: Python, Flask, PostgreSQL
- Coding Style: PEP 8
- Project Structure: MVC
- Preferred LLM: gpt-4
一度作成されると、Sidekick CLIはこのファイルに基づいてAIの動作を調整します。ガイドを適用するには、以下のコマンドを実行してください:
sidekick init
5.VPSのワンクリック展開
Sidekick CLIは、Ubuntu 20.04+システムのVPSデプロイを簡素化します。以下のコマンドを実行してください:
sidekick deploy --vps <VPS_IP地址>
Sidekick CLIが自動的に起動します:
- SSHとユーザーパーミッションを設定する。
- DockerとTraefikをインストールする。
- HTTPSを設定する(デフォルトで使用)
sslip.io
(無料ドメイン名)。
配備状況を確認する:
sidekick status
アプリケーションを更新する:
sidekick deploy --update
この機能は、ダウンタイムなしの導入をサポートし、迅速な稼動プロジェクトに適している。
6.コストとトークンのトラッキング
Sidekick CLIはLLMの使用状況を監視します。現在の消費量を表示します:
sidekick cost
出力にはトークン数とコストの見積もりが含まれます。予算を設定する:
sidekick cost --set-budget 20.0
サイドキックCLIは、コストが予算に近づくと警告を発する。
7.テレメトリーコントロール
Sidekick CLI はデフォルトで Sentry テレメトリーを有効にし、エラーと使用データを収集します。テレメトリーを無効にします:
sidekick --no-telemetry
このコマンドにより、プライバシーに敏感なユーザーはデータ収集を完全に無効にすることができる。
8.コマンド確認制御
操作をスピードアップするには、「ヨロ」モードを有効にして確認を省略する:
sidekick /yolo
リストア確認:
sidekick /yolo off
また、設定ファイルを使ってデフォルトの動作を設定することもできる:
{
"skip_confirm": true
}
共通コマンド
/help
すべてのコマンドを表示します。/clear
メッセージの履歴を消去します。/compact
メッセージの履歴をまとめ、古い記録を消去します。/dump
現在のメッセージ履歴を表示します(デバッグ用)。exit
Sidekick CLI を終了します。
ほら
- APIキーのセキュリティを確保する。
~/.config/sidekick.json
キーは - VPSの要件展開にはSSHポート(デフォルト22)とパブリックIPが必要です。
- ベータ相限界現在のバージョンにはバグがあるかもしれません。
アプリケーションシナリオ
- ラピッドプロトタイピング
開発者はWebアプリのプロトタイプを迅速に作成する必要があります。Sidekick CLIは、AIによってコードを生成し、設定を自動化することで、アイデアからデプロイまでのプロセスを数日で完了します。 - 低コストVPS導入
低予算のVPSでアプリケーションを実行したい小規模チームのために、Sidekick CLIはワンクリックのデプロイとコスト追跡を提供し、リソースの効率的な使用を保証します。 - AI主導の学習
初心者はSidekick CLIのAI機能を使って新しいフレームワークを学びます。自然言語のプロンプトを入力してサンプルコードを生成し、デバッグしてロジックを理解します。
品質保証
- Sidekick CLIは常時接続する必要がありますか?
はい、AI機能はLLMプロバイダーのAPIに依存しており、ネットワーク接続が必要です。MCPサーバーとVPSの導入にもネットワーク接続が必要です。 - テレメトリーを無効にするには?
うごきだすsidekick --no-telemetry
またはsidekick.json
セットアップ"telemetry": false
. - どのLLMプロバイダーがサポートされていますか?
現在はOpenAI、Anthropicなどをサポートしており、今後追加される予定。 オーラマ およびその他のローカルモデル(ロードマップ参照)。 - コードを提供するには?
リポジトリをクローンし、開発依存関係をインストールする (make install
)、GitHubにPull Requestを提出する。