Native MoonBit SDK for starting and managing an OpenCode server

opencode

sdk

server

process

moon add totto2727/opencode-server-sdk@0.2.1

Download zip

Author

totto2727

Version

0.2.1

License

MIT

Repository

github.com/totto2727-org/monorepo

Last updated

10 days ago

Downloads

Dependencies

moonbitlang/async0.20.3
totto2727/lens0.4.0

README

#opencode-server-sdk

Native MoonBit SDK for starting and managing an OpenCode server.

The server lifecycle follows the handwritten TypeScript SDK contract. This package owns only the server process and its announced URL; callers may use the HTTP client of their choice.

#Usage

@async.with_task_group()  group => {
  let server = @opencode.create_opencode_server(group)
  println(server.url())
  server.close()
}

The task group must outlive the returned server. Call Server::close inside the task-group body on both success and failure; task-group defers run only after child tasks finish, while the managed server is itself a long-lived child task.

Use totto2727/opencode-sdk instead when the application should run agent turns through the opencode CLI.

#
ServerError

source

pub(all) suberror ServerError {
  StartFailed(String)
  StartTimeout(timeout_ms~ : Int, output~ : String)
  MalformedOutput(line~ : String)
  ServerExited(code~ : Int, output~ : String)
  CleanupFailed(String)
} derive(@moonbitlang/core/debug.Debug
Debug)

Failures that can occur while starting or stopping an OpenCode server.

#
Server

source

pub struct Server {
  url : String
  process : @moonbitlang/async/process.Process
Process
  log_dir : String
  closed : Bool
}

A running OpenCode server owned by the task group passed at creation.

#
Server::close

source

async fn Server::close(self : Server) -> Unit raise ServerError

Stop the server, wait for its process, and remove its temporary logs.

Calling close again after a successful close has no effect.

#
Server::url

source

fn Server::url(self : Server) -> String

Return the HTTP base URL announced by the OpenCode server.

#
ServerOptions

source

pub struct ServerOptions {
  hostname : String
  port : Int
  timeout_ms : Int
  config : Json
} derive(@moonbitlang/core/debug.Debug
Debug)

Options for starting an OpenCode server.

When port is omitted, OpenCode selects an available port.

#
ServerOptions::ServerOptions

source

fn ServerOptions::ServerOptions(hostname? : String, port? : Int, timeout_ms? : Int, config? : Json) -> ServerOptions

Construct server options.

#
create_opencode_server

source

async fn[X] create_opencode_server(group : @moonbitlang/async.TaskGroup
TaskGroup[X], options? : ServerOptions, command? : String, extra_env? : Map[String, String]) -> Server raise ServerError

Start an OpenCode server in group.

The task group must outlive the returned server. The process is started as opencode serve, receives OPENCODE_CONFIG_CONTENT, and is hard-cancelled when startup fails or close is called.