> ## Documentation Index
> Fetch the complete documentation index at: https://libops-renovate-github-com-libops-sitectl-0-x.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# resources

> Read common ArchivesSpace resources and diagnostics through shortcut commands.

Use resource shortcuts for common read and diagnostic workflows:

```bash theme={null}
sitectl archivesspace version
sitectl archivesspace repositories
sitectl archivesspace users
sitectl archivesspace search "title:Photographs"
sitectl archivesspace jobs --repo 2
sitectl archivesspace schemas archival_record
sitectl archivesspace diagnostics
```

Pass an ID to read a single repository, user, or job:

```bash theme={null}
sitectl archivesspace repositories 2
sitectl archivesspace users admin
sitectl archivesspace jobs --repo 2 7
```

Use `--repo` for repository-scoped search and job inspection:

```bash theme={null}
sitectl archivesspace search "identifier:MS" --repo 2
sitectl archivesspace jobs --repo 2
```

These shortcuts accept the same read flags as API requests, including `--url`, `--session`, and repeated `--query name=value` filters.

## Reference

`search` and `jobs` add their own scoping flags. The remaining shortcuts
(`repositories`, `users`, `schemas`, `version`, `diagnostics`) share the standard
read flags, with `repositories` shown as a representative example.

### `search`

Search ArchivesSpace records

```bash theme={null}
sitectl archivesspace search QUERY
```

| Flag          | Default                | Description                                                |
| ------------- | ---------------------- | ---------------------------------------------------------- |
| `-q, --query` | `[]`                   | Additional query parameter as name=value. May be repeated. |
| `--repo`      |                        | Repository ID for repository-scoped search.                |
| `--session`   |                        | ArchivesSpace session token for X-ArchivesSpace-Session.   |
| `--type`      |                        | Limit search to an ArchivesSpace record type.              |
| `--url`       | `http://localhost/api` | Base ArchivesSpace API URL.                                |

### `jobs`

List or read ArchivesSpace background jobs for a repository

```bash theme={null}
sitectl archivesspace jobs [ID]
```

| Flag          | Default                | Description                                                |
| ------------- | ---------------------- | ---------------------------------------------------------- |
| `-q, --query` | `[]`                   | Additional query parameter as name=value. May be repeated. |
| `--repo`      |                        | ArchivesSpace repository ID.                               |
| `--session`   |                        | ArchivesSpace session token for X-ArchivesSpace-Session.   |
| `--url`       | `http://localhost/api` | Base ArchivesSpace API URL.                                |

### `repositories`

List or read ArchivesSpace repositories

```bash theme={null}
sitectl archivesspace repositories [ID]
```

| Flag          | Default                | Description                                                |
| ------------- | ---------------------- | ---------------------------------------------------------- |
| `-q, --query` | `[]`                   | Additional query parameter as name=value. May be repeated. |
| `--session`   |                        | ArchivesSpace session token for X-ArchivesSpace-Session.   |
| `--url`       | `http://localhost/api` | Base ArchivesSpace API URL.                                |