boundary/website/content/docs/commands/cache/start.mdx

---
layout: docs
page_title: cache start - Command
description: >-
  The "cache start" command starts the Boundary cache and determines the behavior of the local cache. You can customize log, search, and refresh settings.
---

# cache start

Command: `boundary cache start`

The `boundary cache start` command lets you manually start the Boundary cache and customize the behavior of the local cache.

## Example

The following command starts the Boundary cache in the background:

```shell-session
$ boundary cache start -background
```

## Usage

<CodeBlockConfig hideClipboard>

```shell-session
$ boundary cache start [options] [args]
```

</CodeBlockConfig>

### Command options

- `background` - Starts the Boundary cache in the background.
The default value is `false`.
By default, the cache starts in the foreground.
- `log-format=<string>` - Specifies the log format, mostly as a fallback for events.
Supported values are `standard` and `json`.
- `max-search-refresh-timeout=<duration>` - If a search request triggers a best effort refresh, this value specifies how long the refresh should run before time out.
In the event of a timeout, Boundary uses the stale data that is currently in the cache.
The default value is 7 seconds.
- `max-search-staleness=<duration>` - The amount of time that can pass since the last refresh before the client cache causes a blocking refresh.
The blocking refresh occurs when you perform the `boundary search` command.
It requires Boundary to refresh the local cache using the control plane.
The default value is 30 seconds.
- `refresh-interval` - A duration that specifies how frequently the client cache should query Boundary for changes to sessions and targets.
Note that Boundary only searches sessions and targets that the user who ran the command has access to.

@include 'cmd-option-note.mdx'