# LibTmuxWorkspace.read_config

- **Module:** LibTmuxWorkspace
- **Package:** LibTmuxWorkspace
- **Language:** Julia
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/packages/LibTmuxWorkspace/src/parser.jl#L149
- **Page:** https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-read_config/

```
read_config(path::AbstractString; format, limits)
```

## Methods

Read at most `max_bytes + 1` bytes from an explicitly supplied file. Infer YAML from `.yaml`/`.yml` and JSON from `.json`; otherwise require `format`. The absolute source path supplies the default directory during `expand`.

```julia
read_config(path; format=nothing, limits=ConfigLimits()) -> WorkspaceDocument
```

## Parameters

- `path` (`AbstractString`)
- `format`
  Default: `nothing`.
- `limits` (`ConfigLimits`)
  Default: `ConfigLimits()`.