@comty.io/core 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -97,11 +97,11 @@ Optional flags: `--port`, `--model`, `--project-key`, `--api-url`. Without a com
97
97
 
98
98
  ### Choose your coding agent
99
99
 
100
- Install and sign in to the coding agent CLI you want to use, then set `--agent` (or the Vite plugin's `agent` option). This selects a **coding agent**, not just a model API: the CLI reads the project, edits files and runs checks. Comty does not install the agent or provide its credentials.
100
+ Use the coding agent CLI already installed and signed in on your computer, then set `--agent` (or the Vite plugin's `agent` option). It must be available on the development server's `PATH`; no agent package is needed in your project. This selects a **coding agent**, not just a model API: the CLI reads the project, edits files and runs checks. Comty does not install the agent or provide its credentials. If the CLI is missing, install it once using that agent's instructions. If its version does not support your chosen model, update that existing CLI.
101
101
 
102
102
  To choose a model, add `model: 'your-agent-model-id'` to the Vite plugin or `--model your-agent-model-id` to `comty dev`. Model IDs belong to the selected agent and must be available on your account. Leave this option out to use its CLI default.
103
103
 
104
- | Agent | `agent` value | CLI to install and sign in to |
104
+ | Agent | `agent` value | Existing CLI command |
105
105
  | --- | --- | --- |
106
106
  | Codex | `codex` | `codex` |
107
107
  | Claude Code | `claude` | `claude` |
@@ -115,10 +115,10 @@ Gemini CLI runs through its [ACP mode](https://github.com/google-gemini/gemini-c
115
115
 
116
116
  ## Using the agent
117
117
 
118
- Codex and Claude use the project's local CLI when present, otherwise `codex` or `claude` on PATH. Cursor uses `agent`, Gemini uses `gemini`, and Grok Build uses `grok` on PATH. Tool permission requests are relayed to the Comty sidebar; Claude uses a local MCP tool for this. Comty does not provision an AI subscription or credentials.
118
+ Comty resolves each agent through the development server's PATH: `codex`, `claude`, `agent` (Cursor), `gemini`, or `grok`. It reuses that CLI's configuration and login. Tool permission requests are relayed to the Comty sidebar; Claude uses a local MCP tool for this. Comty does not provision an AI subscription or credentials.
119
119
 
120
- 1. Open the toolbar with Shift S or Shift I.
121
- 2. Select the `</>` Agent tool and click an element.
120
+ 1. Press **Shift A** to open Agent mode directly (localhost only), or select the `</>` Agent tool from the toolbar.
121
+ 2. Click an element.
122
122
  3. Ask a question or describe a change. **Apply globally** is off by default, so the request targets this element. Turn it on to request a change to every instance of the same component variant. The agent must identify that component and variant in source before applying the broader change. No Comty account is needed for this local flow.
123
123
  4. Work in progress is indicated on the element, without a progress toast. Click the Agent tool again to read the latest answer or change summary. Requested tool permissions and errors still appear when they need attention.
124
124
  5. In an existing shared comment thread, reply with `@Agent` to start a local agent task. Your question and the agent's response remain in the shared thread. This requires a project editor account, a project key, and the local companion running in your browser. Without `@Agent`, replies remain ordinary human comments.
@@ -130,3 +130,11 @@ Comty starts a separate agent session. It does not send instructions into an alr
130
130
  Direct Agent requests are never sent to the Comty API or its database. Their prompt and page context are sent to the selected AI provider by its coding agent. In a shared thread, the `@Agent` message and final answer are stored as comment replies; the thread transcript and page context are sent to the selected coding agent. Standard shared comments retain their existing Comty authentication and storage.
131
131
 
132
132
  Add `.comty/` to your application's `.gitignore`. Keep the companion on loopback; LAN binding, tunnels and production hosting are unsupported. Requests require the random token of the running development session and its exact origin.
133
+
134
+ ## Inspector annotations and area captures
135
+
136
+ In Inspect (**Shift I**), choose **Annotate** (**D**) to draw with a pencil, rectangle, ellipse or arrow. Choose a stroke from the visual width buttons and a color from the swatches or the custom color picker. **⌘/Ctrl Z** undoes the last annotation; the trash button clears all drawings. **Escape** cancels an unfinished stroke, then exits the tool. Drawings follow document scrolling, remain when changing tools, and reset on navigation or reload.
137
+
138
+ Choose **Capture area** (**S** while inspecting), then drag a rectangle in either direction to download a PNG. The image includes visible annotations, ruler strips, ruler guides, layout guides and distance measurements, without the toolbar or selection controls. **Escape** cancels. Captures stay local and use the existing DOM snapshot engine; inaccessible embedded pages and protected media may not appear exactly as rendered by the browser.
139
+
140
+ The local Agent refreshes on entry and when returning to the tab. It polls only while tasks are pending or running; those progress checks do not reload shared comments. Inspector tools make no polling requests while idle.