opencode_client

OpencodeClient - the Ruby gem for the opencode

opencode api

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.3
  • Package version: 1.0.3
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build opencode_client.gemspec

Then either install the gem locally:

gem install ./opencode_client-1.0.3.gem

(for development, run gem install --dev ./opencode_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'opencode_client', '~> 1.0.3'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'opencode_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'opencode_client'

api_instance = OpencodeClient::DefaultApi.new
opts = {
  directory: 'directory_example' # String | 
}

begin
  #List agents
  result = api_instance.app_agents(opts)
  p result
rescue OpencodeClient::ApiError => e
  puts "Exception when calling DefaultApi->app_agents: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
OpencodeClient::DefaultApi app_agents GET /agent List agents
OpencodeClient::DefaultApi app_log POST /log Write log
OpencodeClient::DefaultApi auth_set PUT /auth/providerID Set auth credentials
OpencodeClient::DefaultApi command_list GET /command List commands
OpencodeClient::DefaultApi config_get GET /config Get configuration
OpencodeClient::DefaultApi config_providers GET /config/providers List config providers
OpencodeClient::DefaultApi config_update PATCH /config Update configuration
OpencodeClient::DefaultApi event_subscribe GET /event Subscribe to events
OpencodeClient::DefaultApi file_list GET /file List files
OpencodeClient::DefaultApi file_read GET /file/content Read file
OpencodeClient::DefaultApi file_status GET /file/status Get file status
OpencodeClient::DefaultApi find_files GET /find/file Find files
OpencodeClient::DefaultApi find_symbols GET /find/symbol Find symbols
OpencodeClient::DefaultApi find_text GET /find Find text
OpencodeClient::DefaultApi formatter_status GET /formatter Get formatter status
OpencodeClient::DefaultApi global_dispose POST /global/dispose Dispose instance
OpencodeClient::DefaultApi global_event GET /global/event Get global events
OpencodeClient::DefaultApi global_health GET /global/health Get health
OpencodeClient::DefaultApi instance_dispose POST /instance/dispose Dispose instance
OpencodeClient::DefaultApi lsp_status GET /lsp Get LSP status
OpencodeClient::DefaultApi mcp_add POST /mcp Add MCP server
OpencodeClient::DefaultApi mcp_auth_authenticate POST /mcp/name/auth/authenticate Authenticate MCP OAuth
OpencodeClient::DefaultApi mcp_auth_callback POST /mcp/name/auth/callback Complete MCP OAuth
OpencodeClient::DefaultApi mcp_auth_remove DELETE /mcp/name/auth Remove MCP OAuth
OpencodeClient::DefaultApi mcp_auth_start POST /mcp/name/auth Start MCP OAuth
OpencodeClient::DefaultApi mcp_connect POST /mcp/name/connect
OpencodeClient::DefaultApi mcp_disconnect POST /mcp/name/disconnect
OpencodeClient::DefaultApi mcp_status GET /mcp Get MCP status
OpencodeClient::DefaultApi part_delete DELETE /session/sessionID/message/messageID/part/partID
OpencodeClient::DefaultApi part_update PATCH /session/sessionID/message/messageID/part/partID
OpencodeClient::DefaultApi path_get GET /path Get paths
OpencodeClient::DefaultApi permission_list GET /permission List pending permissions
OpencodeClient::DefaultApi permission_respond POST /session/sessionID/permissions/permissionID Respond to permission
OpencodeClient::DefaultApi project_current GET /project/current Get current project
OpencodeClient::DefaultApi project_list GET /project List all projects
OpencodeClient::DefaultApi project_update PATCH /project/projectID Update project
OpencodeClient::DefaultApi provider_auth GET /provider/auth Get provider auth methods
OpencodeClient::DefaultApi provider_list GET /provider List providers
OpencodeClient::DefaultApi provider_oauth_authorize POST /provider/providerID/oauth/authorize OAuth authorize
OpencodeClient::DefaultApi provider_oauth_callback POST /provider/providerID/oauth/callback OAuth callback
OpencodeClient::DefaultApi pty_connect GET /pty/ptyID/connect Connect to PTY session
OpencodeClient::DefaultApi pty_create POST /pty Create PTY session
OpencodeClient::DefaultApi pty_get GET /pty/ptyID Get PTY session
OpencodeClient::DefaultApi pty_list GET /pty List PTY sessions
OpencodeClient::DefaultApi pty_remove DELETE /pty/ptyID Remove PTY session
OpencodeClient::DefaultApi pty_update PUT /pty/ptyID Update PTY session
OpencodeClient::DefaultApi session_abort POST /session/sessionID/abort Abort session
OpencodeClient::DefaultApi session_command POST /session/sessionID/command Send command
OpencodeClient::DefaultApi session_create POST /session Create session
OpencodeClient::DefaultApi session_delete DELETE /session/sessionID Delete session
OpencodeClient::DefaultApi session_diff GET /session/sessionID/diff Get session diff
OpencodeClient::DefaultApi session_fork POST /session/sessionID/fork Fork session
OpencodeClient::DefaultApi session_init POST /session/sessionID/init Initialize session
OpencodeClient::DefaultApi session_list GET /session List sessions
OpencodeClient::DefaultApi session_message GET /session/sessionID/message/messageID Get message
OpencodeClient::DefaultApi session_messages GET /session/sessionID/message Get session messages
OpencodeClient::DefaultApi session_prompt POST /session/sessionID/message Send message
OpencodeClient::DefaultApi session_prompt_async POST /session/sessionID/prompt_async Send async message
OpencodeClient::DefaultApi session_revert POST /session/sessionID/revert Revert message
OpencodeClient::DefaultApi session_share POST /session/sessionID/share Share session
OpencodeClient::DefaultApi session_shell POST /session/sessionID/shell Run shell command
OpencodeClient::DefaultApi session_status GET /session/status Get session status
OpencodeClient::DefaultApi session_summarize POST /session/sessionID/summarize Summarize session
OpencodeClient::DefaultApi session_todo GET /session/sessionID/todo Get session todos
OpencodeClient::DefaultApi session_unrevert POST /session/sessionID/unrevert Restore reverted messages
OpencodeClient::DefaultApi session_unshare DELETE /session/sessionID/share Unshare session
OpencodeClient::DefaultApi session_update PATCH /session/sessionID Update session
OpencodeClient::DefaultApi tool_ids GET /experimental/tool/ids List tool IDs
OpencodeClient::DefaultApi tool_list GET /experimental/tool List tools
OpencodeClient::DefaultApi tui_append_prompt POST /tui/append-prompt Append TUI prompt
OpencodeClient::DefaultApi tui_clear_prompt POST /tui/clear-prompt Clear TUI prompt
OpencodeClient::DefaultApi tui_control_next GET /tui/control/next Get next TUI request
OpencodeClient::DefaultApi tui_control_response POST /tui/control/response Submit TUI response
OpencodeClient::DefaultApi tui_execute_command POST /tui/execute-command Execute TUI command
OpencodeClient::DefaultApi tui_open_help POST /tui/open-help Open help dialog
OpencodeClient::DefaultApi tui_open_models POST /tui/open-models Open models dialog
OpencodeClient::DefaultApi tui_open_sessions POST /tui/open-sessions Open sessions dialog
OpencodeClient::DefaultApi tui_open_themes POST /tui/open-themes Open themes dialog
OpencodeClient::DefaultApi tui_publish POST /tui/publish Publish TUI event
OpencodeClient::DefaultApi tui_show_toast POST /tui/show-toast Show TUI toast
OpencodeClient::DefaultApi tui_submit_prompt POST /tui/submit-prompt Submit TUI prompt
OpencodeClient::DefaultApi vcs_get GET /vcs Get VCS info
OpencodeClient::SessionApi session_children GET /session/sessionID/children Get session children
OpencodeClient::SessionApi session_get GET /session/sessionID Get session

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.