# `WardrikWorkspace.Reads`

The read-only file tools: `read_file`, `list_files` and `search_files`.

Each answer carries the labels of the files it shows, so the run that reads them carries them.

# `list_files`

```elixir
@spec list_files(WardrikWorkspace.Spec.t(), map()) :: {:ok, map()}
```

Lists the files a glob matches, newest first, with each one's size, writer and time.

# `read_file`

```elixir
@spec read_file(WardrikWorkspace.Spec.t(), map()) :: {:ok, map()}
```

Reads a file's lines, numbered from 1, with its version.

# `search_files`

```elixir
@spec search_files(WardrikWorkspace.Spec.t(), map()) :: {:ok, map()}
```

Finds the lines a regular expression matches, with the lines around them where asked.

---

*Consult [api-reference.md](api-reference.md) for complete listing*