> ## Documentation Index > Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # PlanetScale CLI commands: logs export const PlatformAvailability = ({current, vitess, postgres, neki}) => { const docsHref = path => { if (!path) return path; const normalized = path.startsWith('/') ? path : `/${path}`; return normalized; }; const labels = { vitess: 'Vitess', postgres: 'Postgres', neki: 'Neki' }; const combinedLabels = { both: 'Vitess and Postgres', all: 'Vitess, Neki, and Postgres', 'postgres-neki': 'Postgres and Neki' }; if (combinedLabels[current]) { return

{combinedLabels[current]}

; } const hasVitess = current === 'vitess' || Boolean(vitess); const hasPostgres = current === 'postgres' || Boolean(postgres); const hasNeki = current === 'neki' || Boolean(neki); const only = [hasVitess, hasPostgres, hasNeki].filter(Boolean).length === 1; const engines = []; if (current === 'vitess' || current === 'postgres' || current === 'neki') engines.push(current); if (hasVitess && current !== 'vitess') engines.push('vitess'); if (hasNeki && current !== 'neki') engines.push('neki'); if (hasPostgres && current !== 'postgres') engines.push('postgres'); return

{engines.map(engine => { const isCurrent = current === engine; const href = docsHref(engine === 'vitess' ? vitess : engine === 'postgres' ? postgres : neki); const label = only ? `${labels[engine]} only` : labels[engine]; const state = isCurrent || !href ? 'current' : 'link'; if (isCurrent || !href) { return {label} ; } return {label} ; })}

; }; ## Getting Started Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you've installed the `pscale` CLI, you can interact with PlanetScale and manage your databases straight from the command line. ## The `logs` command Query recent logs for a Postgres or Neki branch. By default, the command returns up to 100 entries from the primary server over the last hour, newest first. **Usage:** ```bash theme={null} pscale logs --org ``` ### Available flags | **Flag** | **Description** | | --------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `--org ` | Organization name **(required)** | | `--query ` | Text or LogsQL expression to search for | | `--period ` | Time period to query: `15m`, `1h`, `3h`, `6h`, `12h`, `1d`, `7d`, or `8d`. Defaults to `1h`. | | `--from ` | Start of a custom ISO 8601 time range. Requires `--to`. | | `--to ` | End of a custom ISO 8601 time range. Requires `--from`. | | `--level ` | Include `DEBUG`, `INFO`, `WARNING`, or `ERROR` entries. Repeat the flag or pass a comma-separated list. | | `--server ` | Include the `primary` role or a named server. Repeat the flag or pass a comma-separated list. Defaults to `primary`. | | `--shard ` | Include a Neki shard. Repeat the flag or pass a comma-separated list. | | `--limit ` | Maximum number of entries to return. Defaults to `100`. | | `--page ` | Page to fetch. Defaults to `1`. | | `-h`, `--help` | Help for `logs` | `--period` cannot be combined with `--from` and `--to`. When you use a custom range, provide both timestamps. ### Global flags | **Flag** | **Description** | | ------------------------------------------------------ | -------------------------------------------------- | | `-f`, `--format ` | Output format: `human` (default), `json`, or `csv` | | `--api-token`, `--service-token-id`, `--service-token` | Authentication | | `--api-url ` | API base URL | | `--config ` | Config file | | `--debug` | Enable debug mode | | `--no-color` | Disable color output | ## Examples Show recent primary logs: ```bash theme={null} pscale logs mydatabase main --org myorganization ``` Show errors from the last six hours as JSON: ```bash theme={null} pscale logs mydatabase main --org myorganization \ --period 6h --level ERROR --format json ``` Filter a Neki branch to selected shards: ```bash theme={null} pscale logs mydatabase main --org myorganization \ --shard shard-a --shard shard-b ``` Query a custom time range: ```bash theme={null} pscale logs mydatabase main --org myorganization \ --from 2026-08-20T16:00:00Z \ --to 2026-08-20T18:00:00Z ``` Log output can contain query text and application data. Review it before sharing or attaching it to a support request. ## Related documentation ## Need help? Get help from [the PlanetScale Support team](https://planetscale.com/contact?initial=support), or join our [Discord community](https://pscale.link/community) to see how others are using PlanetScale.