Skip to content

Commit d1b9202

Browse files
committed
docs: README should share more available public lua apis
1 parent 58d612e commit d1b9202

1 file changed

Lines changed: 25 additions & 12 deletions

File tree

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -214,18 +214,31 @@ navigation keymaps, or set individual directions to `false`.
214214

215215
## Lua API
216216

217-
- `require("codex").send_selection()`
218-
- `require("codex").add_file(path)`
219-
- `require("codex").close()`
220-
- `require("codex").clear_input()`
221-
- `require("codex").send_command(slash_cmd)`
222-
- `require("codex").resume(opts)`
223-
- `require("codex").set_model()`
224-
- `require("codex").show_status()`
225-
- `require("codex").show_permissions()`
226-
- `require("codex").compact()`
227-
- `require("codex").review(instructions)`
228-
- `require("codex").show_diff()`
217+
- `require("codex").open(focus)` opens the Codex terminal (`focus` defaults to
218+
`true`).
219+
- `require("codex").close()` closes the active session and resets the send
220+
queue.
221+
- `require("codex").toggle()` toggles terminal visibility for the active
222+
session, or opens one if none exists.
223+
- `require("codex").focus()` focuses the active session, opening one if needed.
224+
- `require("codex").send(text)` sends raw text through the resilient send path.
225+
- `require("codex").clear_input()` sends terminal `<C-c>` to clear current
226+
prompt input.
227+
- `require("codex").send_command(slash_cmd)` sends a slash command (with or
228+
without leading `/`).
229+
- `require("codex").set_model()` sends `/model`.
230+
- `require("codex").show_status()` sends `/status`.
231+
- `require("codex").show_permissions()` sends `/permissions`.
232+
- `require("codex").compact()` sends `/compact`.
233+
- `require("codex").review(instructions)` sends `/review` (or
234+
`/review <instructions>`).
235+
- `require("codex").show_diff()` sends `/diff`.
236+
- `require("codex").resume(opts)` resumes in-process when active, otherwise
237+
launches `codex resume` (`opts.last` adds `--last` on launch).
238+
- `require("codex").send_selection(opts)` sends a range/visual selection with
239+
file path and line metadata.
240+
- `require("codex").add_file(path)` sends `/mention <path>` (or current buffer
241+
path when omitted).
229242

230243
## Providers
231244

0 commit comments

Comments
 (0)