diff --git a/README.md b/README.md index 9ba33c7db..8af99f7bd 100644 --- a/README.md +++ b/README.md @@ -24,39 +24,48 @@ You decide what will matter later and what needs to move with the task. PowerCon ## Works with your agents -Install [PowerContext](https://pypi.org/project/powercontext/): +Install the latest released [PowerContext](https://pypi.org/project/powercontext/): ```bash uv tool install "powercontext[cli,server]==0.1.0" - -# To use the latest unreleased code instead: -# uv tool install "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" ``` -For a persistent personal Server that survives terminal closure and can start again after login, install the native current-user service: +Start a local Server in its own terminal: ```bash -powercontext service install # Uninstall with `powercontext service uninstall` -powercontext service status +powercontext server run ``` -On Windows, the installer asks whether to enable startup at the next login when no login option is supplied; pressing -Enter keeps it disabled. Use `--start-on-login` or `--no-start-on-login` to choose explicitly. +The `powercontext service` command is not available in the `0.1.0` release. Keep `powercontext server run` running +while you use PowerContext, or install the unreleased `master` version below to use the native personal service. + +The Server stores context in a local SQLite database by default. -If you want to use it foreground in a terminal, you can run: +Then set up an agent integration from the matching release. For example: ```bash -powercontext server run +powercontext setup codex --ref powercontext-v0.1.0 ``` -The Server stores context in a local SQLite database by default. +Keep the PowerContext tool and agent integration on the same Git ref. To try the latest unreleased `master`, install +and configure both from `master`: -Then set up an agent integration. For example: +```bash +uv tool install --force "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" +powercontext setup codex --source oceanbase/powercontext --ref master +``` + +The current `master` also provides an optional persistent personal Server that survives terminal closure and can +start again after login: ```bash -powercontext setup codex --ref v0.1.0 # --ref also accepts a Git commit, such as 55616dca. +powercontext service install # Uninstall with `powercontext service uninstall` +powercontext service status ``` +On Windows, the installer asks whether to enable startup at the next login when no login option is supplied; pressing +Enter keeps it disabled. Use `--start-on-login` or `--no-start-on-login` to choose explicitly. + For other agents and deployment options, continue with the [agent setup guide](https://powercontext.oceanbase.io/en/docs/tutorials/agent-quickstart/). Supported agent clients and IDEs connect through MCP or a dedicated integration. diff --git a/README_CN.md b/README_CN.md index 8e47b4c7c..5e3da7c3e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -24,39 +24,47 @@ PowerContext 让上下文跟随工作，跨越不同的对话。你回来时， ## 与你使用的 Agent 一起工作 -安装 [PowerContext](https://pypi.org/project/powercontext/)： +安装最新发布的 [PowerContext](https://pypi.org/project/powercontext/)： ```bash uv tool install "powercontext[cli,server]==0.1.0" - -# To use the latest unreleased code instead: -# uv tool install "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" ``` -如需让个人 Server 在终端关闭后继续运行，并可以在下次登录后再次启动，请安装原生当前用户服务： +在单独的终端中启动本地 Server： ```bash -powercontext service install # 卸载请运行 `powercontext service uninstall` -powercontext service status +powercontext server run ``` -在 Windows 上，未提供登录启动选项时，安装器会询问是否在下次登录时自动启动；直接按 Enter 的默认选择是不启用。 -需要显式选择时，请使用 `--start-on-login` 或 `--no-start-on-login`。 +`0.1.0` 发布版不包含 `powercontext service` 命令。使用 PowerContext 时，请保持 `powercontext server run` +进程运行；如需使用原生个人服务，请改用下文尚未发布的 `master` 版本。 + +Server 默认将上下文保存到本地 SQLite 数据库。 -如果想在终端以前台方式使用，可以运行： +然后从同一个发布版本配置 Agent 集成。例如： ```bash -powercontext server run +powercontext setup codex --ref powercontext-v0.1.0 ``` -Server 默认将上下文保存到本地 SQLite 数据库。 +PowerContext 工具与 Agent 集成应始终使用同一个 Git ref。如需试用最新但尚未发布的 `master`，请同时从 +`master` 安装工具和配置集成： -然后为 Agent 配置集成。例如： +```bash +uv tool install --force "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" +powercontext setup codex --source oceanbase/powercontext --ref master +``` + +当前 `master` 还提供可选的持久个人 Server，它可以在终端关闭后继续运行，并在下次登录后再次启动： ```bash -powercontext setup codex --ref v0.1.0 # --ref also accepts a Git commit, such as 55616dca. +powercontext service install # 卸载请运行 `powercontext service uninstall` +powercontext service status ``` +在 Windows 上，未提供登录启动选项时，安装器会询问是否在下次登录时自动启动；直接按 Enter 的默认选择是不启用。 +需要显式选择时，请使用 `--start-on-login` 或 `--no-start-on-login`。 + 其他 Agent 的配置方式和部署选项请继续阅读 [Agent 配置指南](https://powercontext.oceanbase.io/zh/docs/tutorials/agent-quickstart/)。支持的 Agent Client 和 IDE 可通过 MCP 或专用集成连接。
diff --git a/README_JP.md b/README_JP.md index 3da0cafd8..62fb4c771 100644 --- a/README_JP.md +++ b/README_JP.md @@ -24,40 +24,48 @@ PowerContext は、会話をまたいでもコンテキストを作業ととも ## 利用中の Agent と接続する -[PowerContext](https://pypi.org/project/powercontext/) をインストールします： +最新リリースの [PowerContext](https://pypi.org/project/powercontext/) をインストールします： ```bash uv tool install "powercontext[cli,server]==0.1.0" - -# To use the latest unreleased code instead: -# uv tool install "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" ``` -ターミナルを閉じても動作を続け、次回ログイン時に再び起動できる個人用 Server を実行するには、現在のユーザー用 -ネイティブサービスをインストールします： +別のターミナルでローカル Server を起動します： ```bash -powercontext service install # Uninstall with `powercontext service uninstall` -powercontext service status +powercontext server run ``` -Windows では、ログイン起動のオプションを指定しない場合、次回ログイン時の自動起動を有効にするか確認します。 -Enter を押すと既定では無効のままです。明示的に選ぶ場合は `--start-on-login` または `--no-start-on-login` を指定します。 +`0.1.0` リリースには `powercontext service` コマンドは含まれていません。PowerContext の使用中は +`powercontext server run` を実行したままにするか、ネイティブの個人用サービスを使用するために、以下の未リリース版 +`master` をインストールしてください。 + +Server はデフォルトで、コンテキストをローカルの SQLite データベースに保存します。 -ターミナルでフォアグラウンド実行する場合は、次のコマンドを使用できます： +次に同じリリースから Agent との連携を設定します。例： ```bash -powercontext server run +powercontext setup codex --ref powercontext-v0.1.0 ``` -Server はデフォルトで、コンテキストをローカルの SQLite データベースに保存します。 +PowerContext ツールと Agent 連携には、常に同じ Git ref を使用してください。最新の未リリース版 `master` を試す場合は、 +ツールのインストールと連携の設定の両方で `master` を指定します： + +```bash +uv tool install --force "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master" +powercontext setup codex --source oceanbase/powercontext --ref master +``` -次に Agent との連携を設定します。例： +現在の `master` では、ターミナルを閉じても動作を続け、次回ログイン時に再び起動できる個人用 Server も利用できます： ```bash -powercontext setup codex --ref v0.1.0 # --ref also accepts a Git commit, such as 55616dca. +powercontext service install # アンインストールは `powercontext service uninstall` +powercontext service status ``` +Windows では、ログイン起動のオプションを指定しない場合、次回ログイン時の自動起動を有効にするか確認します。 +Enter を押すと既定では無効のままです。明示的に選ぶ場合は `--start-on-login` または `--no-start-on-login` を指定します。 + その他の Agent の設定方法と導入方法は、[Agent セットアップガイド](https://powercontext.oceanbase.io/en/docs/tutorials/agent-quickstart/)を参照してください。対応する Agent クライアントと IDE は MCP または専用の連携機能で接続できます。