# `smallforce workspace get`

Read an indexed workspace text document

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.8. Run `smallforce workspace get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce workspace get [options] <path>

Read an indexed workspace text document

Arguments:
  path                   Workspace-relative path returned by search

Options:
  --offset <characters>  Character offset, starting at 0
  --max-chars <count>    Maximum characters to return, up to 1000000
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce workspace`](/docs/cli/commands/workspace): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.
