@hasna/codewith-sdk 0.1.26

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 OpenAI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/MODIFICATIONS.md

@@ -0,0 +1,17 @@
+# Modifications
+
+Codewith is a modified derivative of OpenAI Codex.
+
+Original work: OpenAI Codex, copyright 2025 OpenAI, licensed under the Apache
+License, Version 2.0.
+
+Derivative work: Codewith, copyright 2026 Hasna.
+
+Unless a file or directory is explicitly documented as copied verbatim from an
+upstream or third-party source, files in this distribution may include Hasna
+modifications from the OpenAI Codex codebase. Prominent categories of
+modification include Codewith product branding, package names and release
+metadata, distribution packaging, local state paths, authentication profiles,
+provider configuration, and Codewith-specific documentation.
+
+Detailed source changes are tracked in this repository's git history.

package/NOTICE

@@ -0,0 +1,12 @@
+Codewith
+Copyright 2026 Hasna
+
+Codewith is a modified derivative of OpenAI Codex.
+Portions copyright 2025 OpenAI.
+See MODIFICATIONS.md for a summary of Codewith modifications.
+
+Codewith is not affiliated with, sponsored by, or endorsed by OpenAI.
+
+This project includes code derived from [Ratatui](https://github.com/ratatui/ratatui), licensed under the MIT license.
+Copyright (c) 2016-2022 Florian Dehau
+Copyright (c) 2023-2025 The Ratatui Developers

package/README.md

@@ -0,0 +1,149 @@
+# Codewith SDK
+
+Embed the Codewith agent in your workflows and apps.
+
+The TypeScript SDK wraps the `codewith` CLI from `@hasna/codewith`. It spawns the CLI and exchanges JSONL events over stdin/stdout.
+
+## Installation
+
+```bash
+npm install @hasna/codewith-sdk
+```
+
+Requires Node.js 18+.
+
+## Quickstart
+
+```typescript
+import { Codewith } from "@hasna/codewith-sdk";
+
+const codewith = new Codewith();
+const thread = codewith.startThread();
+const turn = await thread.run("Diagnose the test failure and propose a fix");
+
+console.log(turn.finalResponse);
+console.log(turn.items);
+```
+
+Call `run()` repeatedly on the same `Thread` instance to continue that conversation.
+
+```typescript
+const nextTurn = await thread.run("Implement the fix");
+```
+
+### Streaming responses
+
+`run()` buffers events until the turn finishes. To react to intermediate progress—tool calls, streaming responses, and file change notifications—use `runStreamed()` instead, which returns an async generator of structured events.
+
+```typescript
+const { events } = await thread.runStreamed("Diagnose the test failure and propose a fix");
+
+for await (const event of events) {
+  switch (event.type) {
+    case "item.completed":
+      console.log("item", event.item);
+      break;
+    case "turn.completed":
+      console.log("usage", event.usage);
+      break;
+  }
+}
+```
+
+### Structured output
+
+The Codewith agent can produce a JSON response that conforms to a specified schema. The schema can be provided for each turn as a plain JSON object.
+
+```typescript
+const schema = {
+  type: "object",
+  properties: {
+    summary: { type: "string" },
+    status: { type: "string", enum: ["ok", "action_required"] },
+  },
+  required: ["summary", "status"],
+  additionalProperties: false,
+} as const;
+
+const turn = await thread.run("Summarize repository status", { outputSchema: schema });
+console.log(turn.finalResponse);
+```
+
+You can also create a JSON schema from a [Zod schema](https://github.com/colinhacks/zod) using the [`zod-to-json-schema`](https://www.npmjs.com/package/zod-to-json-schema) package and setting the `target` to `"openAi"`.
+
+```typescript
+const schema = z.object({
+  summary: z.string(),
+  status: z.enum(["ok", "action_required"]),
+});
+
+const turn = await thread.run("Summarize repository status", {
+  outputSchema: zodToJsonSchema(schema, { target: "openAi" }),
+});
+console.log(turn.finalResponse);
+```
+
+### Attaching images
+
+Provide structured input entries when you need to include images alongside text. Text entries are concatenated into the final prompt while image entries are passed to the Codewith CLI via `--image`.
+
+```typescript
+const turn = await thread.run([
+  { type: "text", text: "Describe these screenshots" },
+  { type: "local_image", path: "./ui.png" },
+  { type: "local_image", path: "./diagram.jpg" },
+]);
+```
+
+### Resuming an existing thread
+
+Threads are persisted in `~/.codewith/sessions`. If you lose the in-memory `Thread` object, reconstruct it with `resumeThread()` and keep going.
+
+```typescript
+const savedThreadId = process.env.CODEX_THREAD_ID!;
+const thread = codewith.resumeThread(savedThreadId);
+await thread.run("Implement the fix");
+```
+
+### Working directory controls
+
+Codewith runs in the current working directory by default. To avoid unrecoverable errors, Codewith requires the working directory to be a Git repository. You can skip the Git repository check by passing the `skipGitRepoCheck` option when creating a thread.
+
+```typescript
+const thread = codewith.startThread({
+  workingDirectory: "/path/to/project",
+  skipGitRepoCheck: true,
+});
+```
+
+### Controlling the Codewith CLI environment
+
+By default, the Codewith CLI inherits the Node.js process environment. Provide the optional `env` parameter when instantiating the
+`Codewith` client to fully control which variables the Codewith CLI receives—useful for sandboxed hosts like Electron apps.
+
+```typescript
+const codewith = new Codewith({
+  env: {
+    PATH: "/usr/local/bin",
+  },
+});
+```
+
+The SDK still injects its required variables (such as `CODEX_API_KEY`) on top of the environment you provide. If you set
+`baseUrl`, the SDK passes it as a `--config openai_base_url=...` override.
+
+### Passing `--config` overrides
+
+Use the `config` option to provide additional Codewith CLI configuration overrides. The SDK accepts a JSON object, flattens it
+into dotted paths, and serializes values as TOML literals before passing them as repeated `--config key=value` flags.
+
+```typescript
+const codewith = new Codewith({
+  config: {
+    show_raw_agent_reasoning: true,
+    sandbox_workspace_write: { network_access: true },
+  },
+});
+```
+
+Thread options still take precedence for overlapping settings because they are emitted after these global overrides.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,18 @@
+# Third-Party Notices
+
+Codewith release artifacts may include third-party runtime tools. Their license
+texts are distributed in the `licenses/` directory of packaged artifacts.
+
+## Bundled Runtime Tools
+
+- `ripgrep` / `rg`: copyright 2015 Andrew Gallant and contributors. Licensed
+  under either the MIT License or the Unlicense.
+- `zsh`: copyright 1992-2017 Paul Falstad, Richard Coleman, Zoltan Hidvegi,
+  Andrew Main, Peter Stephenson, Sven Wischnowsky, and others. Licensed under
+  the zsh license, with file-specific terms taking precedence in upstream zsh
+  distributions.
+- `bubblewrap` / `bwrap`: distributed under the GNU Library General Public
+  License, version 2, as included in `licenses/bubblewrap-LGPL-2.0.txt`.
+
+This notice file is informational and does not replace the license texts
+distributed with the package.

package/dist/index.d.ts

@@ -0,0 +1,276 @@
+import { ContentBlock } from '@modelcontextprotocol/sdk/types.js';
+
+/** The status of a command execution. */
+type CommandExecutionStatus = "in_progress" | "completed" | "failed";
+/** A command executed by the agent. */
+type CommandExecutionItem = {
+    id: string;
+    type: "command_execution";
+    /** The command line executed by the agent. */
+    command: string;
+    /** Aggregated stdout and stderr captured while the command was running. */
+    aggregated_output: string;
+    /** Set when the command exits; omitted while still running. */
+    exit_code?: number;
+    /** Current status of the command execution. */
+    status: CommandExecutionStatus;
+};
+/** Indicates the type of the file change. */
+type PatchChangeKind = "add" | "delete" | "update";
+/** A set of file changes by the agent. */
+type FileUpdateChange = {
+    path: string;
+    kind: PatchChangeKind;
+};
+/** The status of a file change. */
+type PatchApplyStatus = "completed" | "failed";
+/** A set of file changes by the agent. Emitted once the patch succeeds or fails. */
+type FileChangeItem = {
+    id: string;
+    type: "file_change";
+    /** Individual file changes that comprise the patch. */
+    changes: FileUpdateChange[];
+    /** Whether the patch ultimately succeeded or failed. */
+    status: PatchApplyStatus;
+};
+/** The status of an MCP tool call. */
+type McpToolCallStatus = "in_progress" | "completed" | "failed";
+/**
+ * Represents a call to an MCP tool. The item starts when the invocation is dispatched
+ * and completes when the MCP server reports success or failure.
+ */
+type McpToolCallItem = {
+    id: string;
+    type: "mcp_tool_call";
+    /** Name of the MCP server handling the request. */
+    server: string;
+    /** The tool invoked on the MCP server. */
+    tool: string;
+    /** Arguments forwarded to the tool invocation. */
+    arguments: unknown;
+    /** Result payload returned by the MCP server for successful calls. */
+    result?: {
+        content: ContentBlock[];
+        _meta?: unknown;
+        structured_content: unknown;
+    };
+    /** Error message reported for failed calls. */
+    error?: {
+        message: string;
+    };
+    /** Current status of the tool invocation. */
+    status: McpToolCallStatus;
+};
+/** Response from the agent. Either natural-language text or JSON when structured output is requested. */
+type AgentMessageItem = {
+    id: string;
+    type: "agent_message";
+    /** Either natural-language text or JSON when structured output is requested. */
+    text: string;
+};
+/** Agent's reasoning summary. */
+type ReasoningItem = {
+    id: string;
+    type: "reasoning";
+    text: string;
+};
+/** Captures a web search request. Completes when results are returned to the agent. */
+type WebSearchItem = {
+    id: string;
+    type: "web_search";
+    query: string;
+};
+/** Describes a non-fatal error surfaced as an item. */
+type ErrorItem = {
+    id: string;
+    type: "error";
+    message: string;
+};
+/** An item in the agent's to-do list. */
+type TodoItem = {
+    text: string;
+    completed: boolean;
+};
+/**
+ * Tracks the agent's running to-do list. Starts when the plan is issued, updates as steps change,
+ * and completes when the turn ends.
+ */
+type TodoListItem = {
+    id: string;
+    type: "todo_list";
+    items: TodoItem[];
+};
+/** Canonical union of thread items and their type-specific payloads. */
+type ThreadItem = AgentMessageItem | ReasoningItem | CommandExecutionItem | FileChangeItem | McpToolCallItem | WebSearchItem | TodoListItem | ErrorItem;
+
+/** Emitted when a new thread is started as the first event. */
+type ThreadStartedEvent = {
+    type: "thread.started";
+    /** The identifier of the new thread. Can be used to resume the thread later. */
+    thread_id: string;
+};
+/**
+ * Emitted when a turn is started by sending a new prompt to the model.
+ * A turn encompasses all events that happen while the agent is processing the prompt.
+ */
+type TurnStartedEvent = {
+    type: "turn.started";
+};
+/** Describes the usage of tokens during a turn. */
+type Usage = {
+    /** The number of input tokens used during the turn. */
+    input_tokens: number;
+    /** The number of cached input tokens used during the turn. */
+    cached_input_tokens: number;
+    /** The number of output tokens used during the turn. */
+    output_tokens: number;
+    /** The number of reasoning output tokens used during the turn. */
+    reasoning_output_tokens: number;
+};
+/** Emitted when a turn is completed. Typically right after the assistant's response. */
+type TurnCompletedEvent = {
+    type: "turn.completed";
+    usage: Usage;
+};
+/** Indicates that a turn failed with an error. */
+type TurnFailedEvent = {
+    type: "turn.failed";
+    error: ThreadError;
+};
+/** Emitted when a new item is added to the thread. Typically the item is initially "in progress". */
+type ItemStartedEvent = {
+    type: "item.started";
+    item: ThreadItem;
+};
+/** Emitted when an item is updated. */
+type ItemUpdatedEvent = {
+    type: "item.updated";
+    item: ThreadItem;
+};
+/** Signals that an item has reached a terminal state—either success or failure. */
+type ItemCompletedEvent = {
+    type: "item.completed";
+    item: ThreadItem;
+};
+/** Fatal error emitted by the stream. */
+type ThreadError = {
+    message: string;
+};
+/** Represents an unrecoverable error emitted directly by the event stream. */
+type ThreadErrorEvent = {
+    type: "error";
+    message: string;
+};
+/** Top-level JSONL events emitted by codex exec. */
+type ThreadEvent = ThreadStartedEvent | TurnStartedEvent | TurnCompletedEvent | TurnFailedEvent | ItemStartedEvent | ItemUpdatedEvent | ItemCompletedEvent | ThreadErrorEvent;
+
+type TurnOptions = {
+    /** JSON schema describing the expected agent output. */
+    outputSchema?: unknown;
+    /** AbortSignal to cancel the turn. */
+    signal?: AbortSignal;
+};
+
+/** Completed turn. */
+type Turn = {
+    items: ThreadItem[];
+    finalResponse: string;
+    usage: Usage | null;
+};
+/** Alias for `Turn` to describe the result of `run()`. */
+type RunResult = Turn;
+/** The result of the `runStreamed` method. */
+type StreamedTurn = {
+    events: AsyncGenerator<ThreadEvent>;
+};
+/** Alias for `StreamedTurn` to describe the result of `runStreamed()`. */
+type RunStreamedResult = StreamedTurn;
+/** An input to send to the agent. */
+type UserInput = {
+    type: "text";
+    text: string;
+} | {
+    type: "local_image";
+    path: string;
+};
+type Input = string | UserInput[];
+/** Represent a thread of conversation with the agent. One thread can have multiple consecutive turns. */
+declare class Thread {
+    private _exec;
+    private _options;
+    private _id;
+    private _threadOptions;
+    /** Returns the ID of the thread. Populated after the first turn starts. */
+    get id(): string | null;
+    /** Provides the input to the agent and streams events as they are produced during the turn. */
+    runStreamed(input: Input, turnOptions?: TurnOptions): Promise<StreamedTurn>;
+    private runStreamedInternal;
+    /** Provides the input to the agent and returns the completed turn. */
+    run(input: Input, turnOptions?: TurnOptions): Promise<Turn>;
+}
+
+type CodexConfigValue = string | number | boolean | CodexConfigValue[] | CodexConfigObject;
+type CodexConfigObject = {
+    [key: string]: CodexConfigValue;
+};
+type CodexOptions = {
+    codexPathOverride?: string;
+    baseUrl?: string;
+    apiKey?: string;
+    /**
+     * Additional `--config key=value` overrides to pass to the Codewith CLI.
+     *
+     * Provide a JSON object and the SDK will flatten it into dotted paths and
+     * serialize values as TOML literals so they are compatible with the CLI's
+     * `--config` parsing.
+     */
+    config?: CodexConfigObject;
+    /**
+     * Environment variables passed to the Codewith CLI process. When provided, the SDK
+     * will not inherit variables from `process.env`.
+     */
+    env?: Record<string, string>;
+};
+
+type ApprovalMode = "never" | "on-request" | "on-failure" | "untrusted";
+type SandboxMode = "read-only" | "workspace-write" | "danger-full-access";
+type ModelReasoningEffort = "minimal" | "low" | "medium" | "high" | "xhigh";
+type WebSearchMode = "disabled" | "cached" | "live";
+type ThreadOptions = {
+    model?: string;
+    sandboxMode?: SandboxMode;
+    workingDirectory?: string;
+    skipGitRepoCheck?: boolean;
+    modelReasoningEffort?: ModelReasoningEffort;
+    networkAccessEnabled?: boolean;
+    webSearchMode?: WebSearchMode;
+    webSearchEnabled?: boolean;
+    approvalPolicy?: ApprovalMode;
+    additionalDirectories?: string[];
+};
+
+/**
+ * Codewith is the main class for interacting with the Codewith agent.
+ *
+ * Use the `startThread()` method to start a new thread or `resumeThread()` to resume a previously started thread.
+ */
+declare class Codewith {
+    private exec;
+    private options;
+    constructor(options?: CodexOptions);
+    /**
+     * Starts a new conversation with an agent.
+     * @returns A new thread instance.
+     */
+    startThread(options?: ThreadOptions): Thread;
+    /**
+     * Resumes a conversation with an agent based on the thread id.
+     * Threads are persisted in ~/.codewith/sessions by default.
+     *
+     * @param id The id of the thread to resume.
+     * @returns A new thread instance.
+     */
+    resumeThread(id: string, options?: ThreadOptions): Thread;
+}
+
+export { type AgentMessageItem, type ApprovalMode, Codewith, type CodexOptions, type CommandExecutionItem, type ErrorItem, type FileChangeItem, type Input, type ItemCompletedEvent, type ItemStartedEvent, type ItemUpdatedEvent, type McpToolCallItem, type ModelReasoningEffort, type ReasoningItem, type RunResult, type RunStreamedResult, type SandboxMode, Thread, type ThreadError, type ThreadErrorEvent, type ThreadEvent, type ThreadItem, type ThreadOptions, type ThreadStartedEvent, type TodoListItem, type TurnCompletedEvent, type TurnFailedEvent, type TurnOptions, type TurnStartedEvent, type Usage, type UserInput, type WebSearchItem, type WebSearchMode };