Skip to main content

CLI

Each command of osapi, and the layer that made it: a local group of the command DSL, an endpoint group, a behavior, or a command that is still written by hand. The page of each local group shows its commands, their flags and the inputs that each refuses. The CLI reference has the page of each command.

Every command in this build​

Commands (166)​

COMMANDLAYERDESCRIPTION
osapi agent admission getcommandShow what admits this machine
osapi agent startcommandStart the node agent
osapi behavior chain getcommandShow a chain: its tree, and what each call of each example sends and gets
osapi behavior chain listcommandList each behavior in a chain: what it calls, and what calls it
osapi behavior chain spec getcommandPrint how to build a chain, and the building blocks of this binary
osapi behavior chain validatecommandCheck every chain against the chain rules
osapi behavior createcommandWrite a new behavior's standard layout in an osapi checkout
osapi behavior getcommandShow a behavior: its surfaces, chain, methods, types and telemetry
osapi behavior listcommandList the behaviors this binary has
osapi behavior method getcommandShow one method of a behavior: its fields, constraints, output and examples
osapi behavior spec getcommandPrint the behavior DSL: each option, method, example part and field tag
osapi behavior validatecommandCheck every behavior against the rules the platform relies on
osapi cli command createcommandWrite a new local group that builds and passes its tests
osapi cli command getcommandDescribe one group: its commands, and the flags and refusals of a local group
osapi cli command listcommandList each command of this binary, and the layer that made it
osapi cli command spec getcommandPrint the command DSL: each option, method, refinement, field tag and check
osapi cli command validatecommandCheck every local group against the rules of a definition, and the output of every group
osapi cli docs dsl generatecommandWrite the DSL reference pages of the docs site
osapi cli docs generatecommandWrite the CLI reference pages of the docs site
osapi cli docs reference generatecommandWrite the reference pages of the docs site
osapi client admission admitendpointAdmit a pending machine
osapi client admission deleteendpointDelete a machine
osapi client admission getendpointGet a machine's admission record
osapi client admission listendpointList admission records
osapi client admission rejectendpointReject a pending machine
osapi client admission revokeendpointRevoke an admitted machine
osapi client agent drainendpointDrain an agent
osapi client agent getendpointGet agent details
osapi client agent listendpointList active agents
osapi client agent statusendpointShow the health of each agent
osapi client agent undrainendpointUndrain an agent
osapi client audit exportendpointShow all audit log entries, with no pages
osapi client audit getendpointGet a single audit log entry
osapi client audit listendpointList audit log entries
osapi client controller statusendpointShow the health of the controller
osapi client facts keys listendpointList the fact keys
osapi client file deleteendpointDelete a file from the Object Store
osapi client file getendpointGet file metadata
osapi client file listendpointList stored files
osapi client file stale listendpointList stale file deployments
osapi client file updateendpointReplace a file in the Object Store
osapi client file uploadendpointUpload a file to the Object Store
osapi client health livenessendpointLiveness probe
osapi client health readyendpointReadiness probe
osapi client health statusendpointSystem status and component health
osapi client job deleteendpointDelete a job
osapi client job getendpointGet job details and status
osapi client job listendpointList jobs
osapi client job retryendpointRetry a failed or stuck job
osapi client nats statusendpointShow the health of the NATS server
osapi client node certificate createhand-writtenAdd a custom CA certificate
osapi client node certificate deletehand-writtenRemove a custom CA certificate
osapi client node certificate listhand-writtenList CA certificates
osapi client node certificate updatehand-writtenUpdate a custom CA certificate
osapi client node command exechand-writtenExecute a command directly
osapi client node command shellhand-writtenExecute a shell command
osapi client node container docker createhand-writtenCreate a new container
osapi client node container docker deletehand-writtenDelete a container
osapi client node container docker exechand-writtenExecute a command in a container
osapi client node container docker gethand-writtenGet a container
osapi client node container docker image deletehand-writtenDelete a container image
osapi client node container docker image pullhand-writtenPull a container image
osapi client node container docker listhand-writtenList containers on target node
osapi client node container docker starthand-writtenStart a stopped container
osapi client node container docker stophand-writtenStop a running container
osapi client node disk getbehaviorGet the disk usage of the host
osapi client node file deployhand-writtenDeploy a file from Object Store to a host
osapi client node file statushand-writtenCheck deployment status of a file on a host
osapi client node file undeployhand-writtenRemove a deployed file from a host
osapi client node group createhand-writtenCreate a group
osapi client node group deletehand-writtenDelete a group
osapi client node group gethand-writtenGet a group by name
osapi client node group listhand-writtenList all groups
osapi client node group updatehand-writtenUpdate a group
osapi client node hostname getbehaviorGet the hostname of the host
osapi client node hostname updatebehaviorSet the hostname of the host
osapi client node load getbehaviorGet the load averages of the host
osapi client node log listhand-writtenList journal entries
osapi client node log source listhand-writtenList available log sources
osapi client node memory getbehaviorGet the memory usage of the host
osapi client node network dns deletebehaviorDrop the DNS resolvers osapi set on an interface
osapi client node network dns getbehaviorGet the DNS resolvers of an interface
osapi client node network dns updatebehaviorSet the DNS resolvers of an interface
osapi client node network interface createbehaviorConfigure a network interface
osapi client node network interface deletebehaviorDrop the config osapi has of a network interface
osapi client node network interface getbehaviorGet a network interface of the host
osapi client node network interface listbehaviorList the network interfaces of the host
osapi client node network interface updatebehaviorChange the config osapi has of a network interface
osapi client node network pinghand-writtenPing an address from target hosts
osapi client node network route createbehaviorAdd static routes to an interface
osapi client node network route deletebehaviorDrop the routes osapi has of an interface
osapi client node network route getbehaviorGet the routes of an interface
osapi client node network route listbehaviorList the routes of the host
osapi client node network route updatebehaviorChange the routes osapi has of an interface
osapi client node ntp createhand-writtenCreate NTP configuration
osapi client node ntp deletehand-writtenDelete NTP configuration
osapi client node ntp gethand-writtenGet NTP configuration and sync status
osapi client node ntp updatehand-writtenUpdate NTP configuration
osapi client node os getbehaviorGet the operating system of the host
osapi client node package createbehaviorInstall a package
osapi client node package deletebehaviorRemove a package
osapi client node package getbehaviorGet one installed package
osapi client node package listbehaviorList the packages installed on the host
osapi client node power reboothand-writtenReboot the target host
osapi client node power shutdownhand-writtenShut down the target host
osapi client node process gethand-writtenGet process information by PID
osapi client node process listhand-writtenList running processes
osapi client node process signalhand-writtenSend a signal to a process
osapi client node schedule createhand-writtenCreate a scheduled entry
osapi client node schedule deletehand-writtenDelete a scheduled entry
osapi client node schedule gethand-writtenGet a scheduled entry by name
osapi client node schedule listhand-writtenList all scheduled entries
osapi client node schedule updatehand-writtenUpdate a scheduled entry
osapi client node service createbehaviorDeploy a service
osapi client node service deletebehaviorRemove a service that osapi deployed
osapi client node service disablebehaviorMake a service that osapi deployed not start at boot
osapi client node service enablebehaviorMake a service that osapi deployed start at boot
osapi client node service getbehaviorGet one service
osapi client node service listbehaviorList the services of the host
osapi client node service restartbehaviorRestart a service that osapi deployed
osapi client node service startbehaviorStart a service that osapi deployed
osapi client node service stopbehaviorStop a service that osapi deployed
osapi client node service updatebehaviorDeploy a new unit file for a service
osapi client node status getbehaviorGet the status summary of the host
osapi client node sysctl createbehaviorManage a kernel parameter and apply it
osapi client node sysctl deletebehaviorStop the management of a kernel parameter
osapi client node sysctl getbehaviorGet a kernel parameter's current value, and whether osapi manages it
osapi client node sysctl listbehaviorList the kernel's parameters and which osapi manages
osapi client node sysctl updatebehaviorSet a kernel parameter, manage it, and apply it
osapi client node timezone getbehaviorGet the timezone of the host
osapi client node timezone updatebehaviorSet the timezone of the host
osapi client node updatepackages listbehaviorList the packages the index has newer versions of
osapi client node updatepackages updatebehaviorRefresh the package index
osapi client node uptime getbehaviorGet the uptime of the host
osapi client node user createhand-writtenCreate a user account
osapi client node user deletehand-writtenDelete a user account
osapi client node user gethand-writtenGet a user account by name
osapi client node user listhand-writtenList all user accounts
osapi client node user password updatehand-writtenUpdate a user's password
osapi client node user ssh-key createhand-writtenCreate an SSH authorized key
osapi client node user ssh-key deletehand-writtenDelete an SSH authorized key
osapi client node user ssh-key listhand-writtenList SSH authorized keys
osapi client node user updatehand-writtenUpdate a user account
osapi client telemetry trace getendpointShow the span tree of a trace
osapi config getcommandShow one setting in full
osapi config listcommandList every setting, its value in effect and where it came from
osapi config validatecommandCheck a config file before osapi starts with it
osapi controller endpoint createcommandWrite a new endpoint group that builds and passes its tests
osapi controller endpoint getcommandDescribe one endpoint group: its routes, permissions and operation IDs
osapi controller endpoint listcommandList the endpoint groups this binary has
osapi controller endpoint openapi getcommandPrint the group's part of the OpenAPI spec, as YAML
osapi controller endpoint spec getcommandPrint the endpoint DSL: each option, method, refinement, error and field tag
osapi controller endpoint validatecommandCheck every endpoint group against the rules of a definition
osapi controller key fingerprintcommandShow the fingerprint of the controller's key
osapi controller startcommandStart the controller
osapi initcommandInstall osapi's agent skills into a repository
osapi nats server startcommandStart the embedded NATS server
osapi nats setupcommandCreate osapi's streams and buckets on a NATS server
osapi skill getcommandPrint a skill, or one of its reference files
osapi skill listcommandList the skills that this binary has
osapi startcommandStart all components (NATS, controller, agent)
osapi token generatecommandGenerate a new token
osapi token roles getcommandShow a role and each permission it grants
osapi token roles listcommandList the roles and the permissions each grants
osapi token validatecommandValidate a token for authenticity and claims
osapi versioncommandDisplay the version of osapi
Command42
Endpoint31
Behavior44
Hand written49