### oackctl Quick Start Commands Source: https://oack.io/docs Provides essential commands for getting started with the Oack command-line interface (oackctl). Includes authentication, listing teams and monitors, creating a monitor, and viewing probe results. ```shell # Authenticate (opens browser for device flow) oackctl login # List your teams oackctl teams list # List monitors in a team oackctl monitors list --team # Create a monitor oackctl monitors create --team \ --name "Production API" \ --url "https://api.example.com/health" \ --interval 60 # View probe results oackctl probes list --team --monitor --limit 10 ``` -------------------------------- ### CLI (oackctl) Installation and Usage Source: https://oack.io/docs Instructions for installing and using the Oack command-line interface (`oackctl`) for managing Oack resources. ```APIDOC ## CLI (oackctl) ### Description `oackctl` is the official command-line interface for the Oack platform. It allows you to manage teams, monitors, probes, and other resources. ### Install via Homebrew #### Method Shell command #### Endpoint N/A #### Code Example ```bash brew tap oack-io/tap brew install oackctl ``` ### Install via shell script #### Method Shell command #### Endpoint N/A #### Code Example ```bash curl -sSfL "https://raw.githubusercontent.com/oack-io/oackctl/refs/heads/main/install-oackctl.sh" | bash ``` ### Quick start #### Method Shell commands #### Endpoint N/A #### Code Examples ```bash # Authenticate (opens browser for device flow) oackctl login # List your teams oackctl teams list # List monitors in a team oackctl monitors list --team # Create a monitor oackctl monitors create --team \ --name "Production API" \ --url "https://api.example.com/health" \ --interval 60 # View probe results oackctl probes list --team --monitor --limit 10 ``` ``` -------------------------------- ### Network Checker Installation Source: https://oack.io/docs Instructions for installing the Oack network checker binary on various operating systems and via Docker. ```APIDOC ## Network Checker Installation ### Description Instructions for installing the network checker binary on Linux, macOS, and via Docker. ### Homebrew (macOS / Linux) #### Method Shell command #### Endpoint N/A #### Code Example ```bash brew tap oack-io/tap brew install network-tester ``` ### Shell script #### Method Shell command #### Endpoint N/A #### Code Example ```bash curl -sSfL "https://raw.githubusercontent.com/oack-io/network-tester/refs/heads/main/install-network-tester.sh" | bash ``` ### Docker #### Method Docker command #### Endpoint N/A #### Code Example ```bash docker pull oackio/network-tester:latest mkdir -p $HOME/.net-checker-data docker run --rm \ --cap-add NET_RAW \ -v $HOME/.net-checker-data:/data \ oackio/network-tester:latest \ --token-db /data/tokens.db --mode shared ``` ``` -------------------------------- ### Install oackctl via Shell Script Source: https://oack.io/docs Installs the Oack command-line interface (oackctl) by downloading and executing a shell script from a GitHub repository. This method is useful for systems without Homebrew. ```shell curl -sSfL "https://raw.githubusercontent.com/oack-io/oackctl/refs/heads/main/install-oackctl.sh" | bash ``` -------------------------------- ### Install Network Tester via Shell Script Source: https://oack.io/docs Installs the Oack network tester agent by downloading and executing a shell script from a GitHub repository. This method is suitable for systems where Homebrew is not available or preferred. ```shell curl -sSfL "https://raw.githubusercontent.com/oack-io/network-tester/refs/heads/main/install-network-tester.sh" | bash ``` -------------------------------- ### Install oackctl via Homebrew Source: https://oack.io/docs Installs the Oack command-line interface (oackctl) using the Homebrew package manager on macOS and Linux. This provides a convenient way to interact with the Oack platform from the terminal. ```shell brew tap oack-io/tap brew install oackctl ``` -------------------------------- ### Install Network Tester via Homebrew Source: https://oack.io/docs Installs the Oack network tester agent using the Homebrew package manager on macOS and Linux systems. This is a convenient method for users who already have Homebrew set up. ```shell brew tap oack-io/tap brew install network-tester ``` -------------------------------- ### Run Network Tester via Docker Source: https://oack.io/docs Launches the Oack network tester agent using a Docker container. This method isolates the checker and allows for easy deployment across different environments. It requires Docker to be installed. ```docker docker pull oackio/network-tester:latest mkdir -p $HOME/.net-checker-data docker run --rm \ --cap-add NET_RAW \ -v $HOME/.net-checker-data:/data \ oackio/network-tester:latest \ --token-db /data/tokens.db --mode shared ``` -------------------------------- ### Configure Claude MCP Server Source: https://oack.io/docs Sets up the Model Context Protocol (MCP) server configuration for Claude to access Oack monitoring data. This involves defining the server type, URL, and potentially adding permissions for full access. ```json { "mcpServers": { "oack": { "type": "http", "url": "https://api.oack.io/mcp/" } } } ``` -------------------------------- ### MCP (AI-Assisted Troubleshooting) Configuration Source: https://oack.io/docs Configuration details for enabling AI agents to read Oack monitoring data via the Model Context Protocol (MCP). ```APIDOC ## MCP (AI-Assisted Troubleshooting) ### Description Oack exposes a Model Context Protocol server that lets AI agents read your monitoring data. All MCP tools are read-only. ### Claude Code Config #### Method Configuration object #### Endpoint N/A #### Code Example ```json { "mcpServers": { "oack": { "type": "http", "url": "https://api.oack.io/mcp/" } } } ``` ### Permissions #### Method Terminal command #### Endpoint N/A #### Code Example ```bash /permissions add mcp__oack__* "allow all Oack MCP tools" ``` ``` -------------------------------- ### REST API Overview Source: https://oack.io/docs The Oack platform exposes its full functionality through a REST API. You can access the API at https://api.oack.io/api/v1/. The OpenAPI specification is available at https://api.oack.io/openapi.json for import into tools like Postman and Insomnia. ```APIDOC ## REST API ### Description All platform functionality is available through the REST API at `https://api.oack.io/api/v1/`. Browse the full Swagger documentation. The OpenAPI spec is available at api.oack.io/openapi.json. Import it into **Postman** , **Insomnia** , or any OpenAPI-compatible tool: Postman: **Import → Link →** `https://api.oack.io/openapi.json` ### Endpoint `https://api.oack.io/api/v1/` ### Method GET, POST, PUT, DELETE, etc. (depending on the specific endpoint) ### Parameters Refer to the OpenAPI specification for detailed parameter information for each endpoint. ``` -------------------------------- ### Import OpenAPI Spec to Postman Source: https://oack.io/docs Instructions for importing the Oack platform's OpenAPI specification into Postman. This allows users to explore and interact with the Oack REST API directly within Postman. ```postman Postman: **Import → Link →** `https://api.oack.io/openapi.json` ``` -------------------------------- ### Grant Claude MCP Permissions Source: https://oack.io/docs Adds permissions to allow Claude AI to access all Oack MCP tools without requiring explicit user approval for each action. This is done via a terminal command. ```shell /permissions add mcp__oack__* "allow all Oack MCP tools" ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.