> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simforge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# simforge locations

> Reference for simforge locations: usage, arguments and flags, generated from the CLI.

Generated from the CLI's own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the [command reference](/cli).

## locations find

Structured query: type, subtype, tags, affordances, facts, proximity

```sh theme={null}
simforge locations find [OPTIONS] --map <MAP>
```

Runs on: local runtime.

| Argument / flag | Notes | What |
| - | - | - |
| `--map MAP` | required | The installed map |
| `--type TYPES` | repeatable | Location types, comma-separated (any of) |
| `--subtype SUBTYPES` | repeatable | Subtypes, comma-separated (any of) |
| `--tags TAGS` | repeatable | Tags, comma-separated (any of) |
| `--affordances AFFORDANCES` | repeatable | Affordances, comma-separated (any of) |
| `--facts FACTS` | repeatable | Fact predicates, comma-separated, all of: `k=v`, `k>=v`, `k<=v`, `k!=v`, `k>v`, `k<v`, `k~v`, `k=?`, `k=!?` |
| `--near HANDLE` | | Only locations within --within-m of this handle or id, nearest first |
| `--within-m M` | | Radius for --near, metres (default 250) |
| `--limit N` | | At most this many records (default 25, cap 200) |
| `--cursor CURSOR` | | The next page: the `nextCursor` of the page before it |
| `--diversity-m M` | | Drop results within this many metres of an already selected one |

## locations get

One location by handle or id (optionally with a description paragraph)

```sh theme={null}
simforge locations get [OPTIONS] --map <MAP> <HANDLE_OR_ID>
```

Runs on: local runtime.

| Argument / flag | Notes | What |
| - | - | - |
| `<handle_or_id>` | required | A handle (`junction/rd-38-rd-34`) or id (`loc_...`) |
| `--map MAP` | required | The installed map |
| `--describe` | | Add the natural-language description an agent reads before authoring |

## locations resolve

Free text -> ranked handles (exit 2 when nothing matched)

```sh theme={null}
simforge locations resolve [OPTIONS] --map <MAP> [TEXT]...
```

Runs on: local runtime.

| Argument / flag | Notes | What |
| - | - | - |
| `<text>` | repeatable | Free text ("the crosswalk by the school") |
| `--map MAP` | required | The installed map |
| `--limit N` | | At most this many results (default 8) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.