package current_rpc

  1. Overview
  2. Docs

Module Client.CmdlinerSource

Term for the --cap/-c option to specify the capability file/URI.

Sourceval client_cmd : ?name:string -> ?cap_file:string -> unit -> unit Cmdliner.Cmd.t

client_cmd ?name ?cap_file () creates a command group with all client subcommands.

  • parameter name

    The command name (default: "client")

  • parameter cap_file

    Default capability file path. If provided, --cap becomes optional.

Use this to embed client commands in your application:

  let cmd = Cmd.group info [main_cmd; Current_rpc.Client.Cmdliner.client_cmd ()]
Sourceval standalone_cmd : ?name:string -> unit -> unit Cmdliner.Cmd.t

standalone_cmd ?name () creates a standalone client command.

  • parameter name

    The program name (default: "ocurrent-rpc")

Use this to create a standalone client binary:

  let () = exit @@ Cmd.eval (Current_rpc.Client.Cmdliner.standalone_cmd ())

Individual Subcommands

These are exposed in case you want to cherry-pick specific commands.

Sourceval overview_cmd : unit Cmdliner.Cmd.t
Sourceval jobs_cmd : unit Cmdliner.Cmd.t
Sourceval status_cmd : unit Cmdliner.Cmd.t
Sourceval log_cmd : unit Cmdliner.Cmd.t
Sourceval cancel_cmd : unit Cmdliner.Cmd.t
Sourceval rebuild_cmd : unit Cmdliner.Cmd.t
Sourceval start_cmd : unit Cmdliner.Cmd.t
Sourceval query_cmd : unit Cmdliner.Cmd.t
Sourceval ops_cmd : unit Cmdliner.Cmd.t
Sourceval dot_cmd : unit Cmdliner.Cmd.t
Sourceval confirm_cmd : unit Cmdliner.Cmd.t
Sourceval rebuild_all_cmd : unit Cmdliner.Cmd.t
Sourceval subcommands : unit Cmdliner.Cmd.t list

All client subcommands as a list.