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)
| COMMAND | LAYER | DESCRIPTION |
|---|---|---|
| osapi agent admission get | command | Show what admits this machine |
| osapi agent start | command | Start the node agent |
| osapi behavior chain get | command | Show a chain: its tree, and what each call of each example sends and gets |
| osapi behavior chain list | command | List each behavior in a chain: what it calls, and what calls it |
| osapi behavior chain spec get | command | Print how to build a chain, and the building blocks of this binary |
| osapi behavior chain validate | command | Check every chain against the chain rules |
| osapi behavior create | command | Write a new behavior's standard layout in an osapi checkout |
| osapi behavior get | command | Show a behavior: its surfaces, chain, methods, types and telemetry |
| osapi behavior list | command | List the behaviors this binary has |
| osapi behavior method get | command | Show one method of a behavior: its fields, constraints, output and examples |
| osapi behavior spec get | command | Print the behavior DSL: each option, method, example part and field tag |
| osapi behavior validate | command | Check every behavior against the rules the platform relies on |
| osapi cli command create | command | Write a new local group that builds and passes its tests |
| osapi cli command get | command | Describe one group: its commands, and the flags and refusals of a local group |
| osapi cli command list | command | List each command of this binary, and the layer that made it |
| osapi cli command spec get | command | Print the command DSL: each option, method, refinement, field tag and check |
| osapi cli command validate | command | Check every local group against the rules of a definition, and the output of every group |
| osapi cli docs dsl generate | command | Write the DSL reference pages of the docs site |
| osapi cli docs generate | command | Write the CLI reference pages of the docs site |
| osapi cli docs reference generate | command | Write the reference pages of the docs site |
| osapi client admission admit | endpoint | Admit a pending machine |
| osapi client admission delete | endpoint | Delete a machine |
| osapi client admission get | endpoint | Get a machine's admission record |
| osapi client admission list | endpoint | List admission records |
| osapi client admission reject | endpoint | Reject a pending machine |
| osapi client admission revoke | endpoint | Revoke an admitted machine |
| osapi client agent drain | endpoint | Drain an agent |
| osapi client agent get | endpoint | Get agent details |
| osapi client agent list | endpoint | List active agents |
| osapi client agent status | endpoint | Show the health of each agent |
| osapi client agent undrain | endpoint | Undrain an agent |
| osapi client audit export | endpoint | Show all audit log entries, with no pages |
| osapi client audit get | endpoint | Get a single audit log entry |
| osapi client audit list | endpoint | List audit log entries |
| osapi client controller status | endpoint | Show the health of the controller |
| osapi client facts keys list | endpoint | List the fact keys |
| osapi client file delete | endpoint | Delete a file from the Object Store |
| osapi client file get | endpoint | Get file metadata |
| osapi client file list | endpoint | List stored files |
| osapi client file stale list | endpoint | List stale file deployments |
| osapi client file update | endpoint | Replace a file in the Object Store |
| osapi client file upload | endpoint | Upload a file to the Object Store |
| osapi client health liveness | endpoint | Liveness probe |
| osapi client health ready | endpoint | Readiness probe |
| osapi client health status | endpoint | System status and component health |
| osapi client job delete | endpoint | Delete a job |
| osapi client job get | endpoint | Get job details and status |
| osapi client job list | endpoint | List jobs |
| osapi client job retry | endpoint | Retry a failed or stuck job |
| osapi client nats status | endpoint | Show the health of the NATS server |
| osapi client node certificate create | hand-written | Add a custom CA certificate |
| osapi client node certificate delete | hand-written | Remove a custom CA certificate |
| osapi client node certificate list | hand-written | List CA certificates |
| osapi client node certificate update | hand-written | Update a custom CA certificate |
| osapi client node command exec | hand-written | Execute a command directly |
| osapi client node command shell | hand-written | Execute a shell command |
| osapi client node container docker create | hand-written | Create a new container |
| osapi client node container docker delete | hand-written | Delete a container |
| osapi client node container docker exec | hand-written | Execute a command in a container |
| osapi client node container docker get | hand-written | Get a container |
| osapi client node container docker image delete | hand-written | Delete a container image |
| osapi client node container docker image pull | hand-written | Pull a container image |
| osapi client node container docker list | hand-written | List containers on target node |
| osapi client node container docker start | hand-written | Start a stopped container |
| osapi client node container docker stop | hand-written | Stop a running container |
| osapi client node disk get | behavior | Get the disk usage of the host |
| osapi client node file deploy | hand-written | Deploy a file from Object Store to a host |
| osapi client node file status | hand-written | Check deployment status of a file on a host |
| osapi client node file undeploy | hand-written | Remove a deployed file from a host |
| osapi client node group create | hand-written | Create a group |
| osapi client node group delete | hand-written | Delete a group |
| osapi client node group get | hand-written | Get a group by name |
| osapi client node group list | hand-written | List all groups |
| osapi client node group update | hand-written | Update a group |
| osapi client node hostname get | behavior | Get the hostname of the host |
| osapi client node hostname update | behavior | Set the hostname of the host |
| osapi client node load get | behavior | Get the load averages of the host |
| osapi client node log list | hand-written | List journal entries |
| osapi client node log source list | hand-written | List available log sources |
| osapi client node memory get | behavior | Get the memory usage of the host |
| osapi client node network dns delete | behavior | Drop the DNS resolvers osapi set on an interface |
| osapi client node network dns get | behavior | Get the DNS resolvers of an interface |
| osapi client node network dns update | behavior | Set the DNS resolvers of an interface |
| osapi client node network interface create | behavior | Configure a network interface |
| osapi client node network interface delete | behavior | Drop the config osapi has of a network interface |
| osapi client node network interface get | behavior | Get a network interface of the host |
| osapi client node network interface list | behavior | List the network interfaces of the host |
| osapi client node network interface update | behavior | Change the config osapi has of a network interface |
| osapi client node network ping | hand-written | Ping an address from target hosts |
| osapi client node network route create | behavior | Add static routes to an interface |
| osapi client node network route delete | behavior | Drop the routes osapi has of an interface |
| osapi client node network route get | behavior | Get the routes of an interface |
| osapi client node network route list | behavior | List the routes of the host |
| osapi client node network route update | behavior | Change the routes osapi has of an interface |
| osapi client node ntp create | hand-written | Create NTP configuration |
| osapi client node ntp delete | hand-written | Delete NTP configuration |
| osapi client node ntp get | hand-written | Get NTP configuration and sync status |
| osapi client node ntp update | hand-written | Update NTP configuration |
| osapi client node os get | behavior | Get the operating system of the host |
| osapi client node package create | behavior | Install a package |
| osapi client node package delete | behavior | Remove a package |
| osapi client node package get | behavior | Get one installed package |
| osapi client node package list | behavior | List the packages installed on the host |
| osapi client node power reboot | hand-written | Reboot the target host |
| osapi client node power shutdown | hand-written | Shut down the target host |
| osapi client node process get | hand-written | Get process information by PID |
| osapi client node process list | hand-written | List running processes |
| osapi client node process signal | hand-written | Send a signal to a process |
| osapi client node schedule create | hand-written | Create a scheduled entry |
| osapi client node schedule delete | hand-written | Delete a scheduled entry |
| osapi client node schedule get | hand-written | Get a scheduled entry by name |
| osapi client node schedule list | hand-written | List all scheduled entries |
| osapi client node schedule update | hand-written | Update a scheduled entry |
| osapi client node service create | behavior | Deploy a service |
| osapi client node service delete | behavior | Remove a service that osapi deployed |
| osapi client node service disable | behavior | Make a service that osapi deployed not start at boot |
| osapi client node service enable | behavior | Make a service that osapi deployed start at boot |
| osapi client node service get | behavior | Get one service |
| osapi client node service list | behavior | List the services of the host |
| osapi client node service restart | behavior | Restart a service that osapi deployed |
| osapi client node service start | behavior | Start a service that osapi deployed |
| osapi client node service stop | behavior | Stop a service that osapi deployed |
| osapi client node service update | behavior | Deploy a new unit file for a service |
| osapi client node status get | behavior | Get the status summary of the host |
| osapi client node sysctl create | behavior | Manage a kernel parameter and apply it |
| osapi client node sysctl delete | behavior | Stop the management of a kernel parameter |
| osapi client node sysctl get | behavior | Get a kernel parameter's current value, and whether osapi manages it |
| osapi client node sysctl list | behavior | List the kernel's parameters and which osapi manages |
| osapi client node sysctl update | behavior | Set a kernel parameter, manage it, and apply it |
| osapi client node timezone get | behavior | Get the timezone of the host |
| osapi client node timezone update | behavior | Set the timezone of the host |
| osapi client node updatepackages list | behavior | List the packages the index has newer versions of |
| osapi client node updatepackages update | behavior | Refresh the package index |
| osapi client node uptime get | behavior | Get the uptime of the host |
| osapi client node user create | hand-written | Create a user account |
| osapi client node user delete | hand-written | Delete a user account |
| osapi client node user get | hand-written | Get a user account by name |
| osapi client node user list | hand-written | List all user accounts |
| osapi client node user password update | hand-written | Update a user's password |
| osapi client node user ssh-key create | hand-written | Create an SSH authorized key |
| osapi client node user ssh-key delete | hand-written | Delete an SSH authorized key |
| osapi client node user ssh-key list | hand-written | List SSH authorized keys |
| osapi client node user update | hand-written | Update a user account |
| osapi client telemetry trace get | endpoint | Show the span tree of a trace |
| osapi config get | command | Show one setting in full |
| osapi config list | command | List every setting, its value in effect and where it came from |
| osapi config validate | command | Check a config file before osapi starts with it |
| osapi controller endpoint create | command | Write a new endpoint group that builds and passes its tests |
| osapi controller endpoint get | command | Describe one endpoint group: its routes, permissions and operation IDs |
| osapi controller endpoint list | command | List the endpoint groups this binary has |
| osapi controller endpoint openapi get | command | Print the group's part of the OpenAPI spec, as YAML |
| osapi controller endpoint spec get | command | Print the endpoint DSL: each option, method, refinement, error and field tag |
| osapi controller endpoint validate | command | Check every endpoint group against the rules of a definition |
| osapi controller key fingerprint | command | Show the fingerprint of the controller's key |
| osapi controller start | command | Start the controller |
| osapi init | command | Install osapi's agent skills into a repository |
| osapi nats server start | command | Start the embedded NATS server |
| osapi nats setup | command | Create osapi's streams and buckets on a NATS server |
| osapi skill get | command | Print a skill, or one of its reference files |
| osapi skill list | command | List the skills that this binary has |
| osapi start | command | Start all components (NATS, controller, agent) |
| osapi token generate | command | Generate a new token |
| osapi token roles get | command | Show a role and each permission it grants |
| osapi token roles list | command | List the roles and the permissions each grants |
| osapi token validate | command | Validate a token for authenticity and claims |
| osapi version | command | Display the version of osapi |
| Command | 42 |
| Endpoint | 31 |
| Behavior | 44 |
| Hand written | 49 |
osapi agent admission
Show what admits this machine. osapi cli command get --name agent admission
osapi agent
Run the agent. osapi cli command get --name agent shows the same.
osapi behavior chain
Show and check the chains of behaviors that a behavior calls.
osapi behavior
List, describe and validate the behaviors this binary has.
osapi cli command
List, describe and validate the local commands, and print their DSL.
osapi cli docs
Write the CLI reference pages of the docs site.
osapi config
List, get and validate osapi's settings. osapi cli command get --name config
osapi controller endpoint
List, describe and validate the controller's own endpoints, and print their DSL.
osapi controller key
Read the key pair of the controller on this host.
osapi controller
Run the controller. osapi cli command get --name controller shows the same.
osapi nats server
Run the embedded NATS server. osapi cli command get --name nats server shows
osapi nats
Create osapi's streams and buckets on a NATS server.
osapi skill
Show the agent skills that this binary has. osapi cli command get --name skill
osapi token
Generate and validate API tokens. osapi cli command get --name token shows the