AmpSdk (AmpSdk v0.6.0)

Copy Markdown View Source

Elixir SDK for the Amp CLI.

Provides programmatic access to Amp's AI-powered coding agent via the CLI.

Summary

Functions

create_permission(tool, action, opts \\ [])
create_user_message(text)

See AmpSdk.Types.create_user_message/1.

execute(input, options \\ %Options{})
mcp_add(name, command_or_url, opts \\ [])

See AmpSdk.MCP.add/3.

mcp_approve(name)

See AmpSdk.MCP.approve/1.

mcp_doctor()

See AmpSdk.MCP.doctor/0.

mcp_list(opts \\ [])

See AmpSdk.MCP.list/1.

mcp_oauth_login(server_name, opts \\ [])

See AmpSdk.MCP.oauth_login/2.

mcp_oauth_logout(server_name, opts \\ [])

See AmpSdk.MCP.oauth_logout/2.

mcp_oauth_status(server_name, opts \\ [])

See AmpSdk.MCP.oauth_status/2.

mcp_remove(name)

See AmpSdk.MCP.remove/1.

permissions_add(tool, action, opts \\ [])

See AmpSdk.Permissions.add/3.

permissions_list(opts \\ [])

See AmpSdk.Permissions.list/1.

permissions_test(tool_name, opts \\ [])

See AmpSdk.Permissions.test/2.

review(opts \\ [])

See AmpSdk.Review.run/1.

run(prompt, options \\ %Options{})
skills_add(source)

See AmpSdk.Skills.add/1.

skills_info(name)

See AmpSdk.Skills.info/1.

skills_list()

See AmpSdk.Skills.list/0.

skills_remove(name)

See AmpSdk.Skills.remove/1.

tasks_import(json_file, opts \\ [])

See AmpSdk.Tasks.import_tasks/2.

tasks_list()

See AmpSdk.Tasks.list/0.

threads_archive(thread_id)

See AmpSdk.Threads.archive/1.

threads_delete(thread_id)

See AmpSdk.Threads.delete/1.

threads_handoff(thread_id, opts \\ [])

See AmpSdk.Threads.handoff/2.

threads_list(opts \\ [])

See AmpSdk.Threads.list/1.

threads_markdown(thread_id)

See AmpSdk.Threads.markdown/1.

threads_new(opts \\ [])

See AmpSdk.Threads.new/1.

threads_rename(thread_id, name)

See AmpSdk.Threads.rename/2.

threads_replay(thread_id, opts \\ [])

See AmpSdk.Threads.replay/2.

threads_search(query, opts \\ [])

See AmpSdk.Threads.search/2.

threads_share(thread_id, opts \\ [])

See AmpSdk.Threads.share/2.

tools_list()

See AmpSdk.Tools.list/0.

tools_make(tool_name, opts \\ [])

See AmpSdk.Tools.make/2.

tools_show(tool_name)

See AmpSdk.Tools.show/1.

tools_use(tool_name, opts \\ [])

See AmpSdk.Tools.use/2.

usage()

See AmpSdk.Usage.info/0.

Functions

create_permission(tool, action, opts \\ [])

@spec create_permission(String.t(), String.t(), keyword()) ::
  AmpSdk.Types.Permission.t()

create_user_message(text)

@spec create_user_message(String.t()) :: AmpSdk.Types.UserInputMessage.t()

See AmpSdk.Types.create_user_message/1.

execute(input, options \\ %Options{})

@spec execute(
  String.t() | [AmpSdk.Types.UserInputMessage.t() | map()],
  AmpSdk.Types.Options.t()
) ::
  Enumerable.t(AmpSdk.Types.stream_message())

mcp_add(name, command_or_url, opts \\ [])

See AmpSdk.MCP.add/3.

mcp_approve(name)

See AmpSdk.MCP.approve/1.

mcp_doctor()

See AmpSdk.MCP.doctor/0.

mcp_list(opts \\ [])

@spec mcp_list(keyword()) ::
  {:ok, [AmpSdk.Types.MCPServer.t()]} | {:error, AmpSdk.Error.t()}

See AmpSdk.MCP.list/1.

mcp_oauth_login(server_name, opts \\ [])

See AmpSdk.MCP.oauth_login/2.

mcp_oauth_logout(server_name, opts \\ [])

See AmpSdk.MCP.oauth_logout/2.

mcp_oauth_status(server_name, opts \\ [])

See AmpSdk.MCP.oauth_status/2.

mcp_remove(name)

See AmpSdk.MCP.remove/1.

permissions_add(tool, action, opts \\ [])

See AmpSdk.Permissions.add/3.

permissions_list(opts \\ [])

@spec permissions_list(keyword()) ::
  {:ok, [AmpSdk.Types.PermissionRule.t()]} | {:error, AmpSdk.Error.t()}

See AmpSdk.Permissions.list/1.

permissions_test(tool_name, opts \\ [])

See AmpSdk.Permissions.test/2.

review(opts \\ [])

See AmpSdk.Review.run/1.

run(prompt, options \\ %Options{})

@spec run(String.t(), AmpSdk.Types.Options.t()) ::
  {:ok, String.t()} | {:error, AmpSdk.Error.t()}

skills_add(source)

See AmpSdk.Skills.add/1.

skills_info(name)

See AmpSdk.Skills.info/1.

skills_list()

See AmpSdk.Skills.list/0.

skills_remove(name)

See AmpSdk.Skills.remove/1.

tasks_import(json_file, opts \\ [])

See AmpSdk.Tasks.import_tasks/2.

tasks_list()

See AmpSdk.Tasks.list/0.

threads_archive(thread_id)

See AmpSdk.Threads.archive/1.

threads_delete(thread_id)

See AmpSdk.Threads.delete/1.

threads_handoff(thread_id, opts \\ [])

See AmpSdk.Threads.handoff/2.

threads_list(opts \\ [])

@spec threads_list(keyword()) ::
  {:ok, [AmpSdk.Types.ThreadSummary.t()]} | {:error, AmpSdk.Error.t()}

See AmpSdk.Threads.list/1.

threads_markdown(thread_id)

See AmpSdk.Threads.markdown/1.

threads_new(opts \\ [])

See AmpSdk.Threads.new/1.

threads_rename(thread_id, name)

See AmpSdk.Threads.rename/2.

threads_replay(thread_id, opts \\ [])

See AmpSdk.Threads.replay/2.

threads_search(query, opts \\ [])

See AmpSdk.Threads.search/2.

threads_share(thread_id, opts \\ [])

See AmpSdk.Threads.share/2.

tools_list()

See AmpSdk.Tools.list/0.

tools_make(tool_name, opts \\ [])

See AmpSdk.Tools.make/2.

tools_show(tool_name)

See AmpSdk.Tools.show/1.

tools_use(tool_name, opts \\ [])

See AmpSdk.Tools.use/2.

usage()

See AmpSdk.Usage.info/0.