resources

Use resource shortcuts for common read and diagnostic workflows:

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:

sitectl archivesspace repositories 2
sitectl archivesspace users admin
sitectl archivesspace jobs --repo 2 7

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

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-file, and repeated --query name=value filters. You can also set ARCHIVESSPACE_SESSION_FILE once for a sequence of read commands.

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

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-file`		Read the ArchivesSpace session from this local file instead of process arguments. Defaults to ARCHIVESSPACE_SESSION_FILE or ARCHIVESSPACE_SESSION.
`--type`		Limit search to an ArchivesSpace record type.
`--url`	`http://127.0.0.1:8089`	Base ArchivesSpace API URL reachable from the ArchivesSpace container.

`jobs`

List or read ArchivesSpace background jobs for a repository

sitectl archivesspace jobs [ID]

Flag	Default	Description
`-q, --query`	`[]`	Additional query parameter as name=value. May be repeated.
`--repo`		ArchivesSpace repository ID.
`--session-file`		Read the ArchivesSpace session from this local file instead of process arguments. Defaults to ARCHIVESSPACE_SESSION_FILE or ARCHIVESSPACE_SESSION.
`--url`	`http://127.0.0.1:8089`	Base ArchivesSpace API URL reachable from the ArchivesSpace container.

`repositories`

List or read ArchivesSpace repositories

sitectl archivesspace repositories [ID]

Flag	Default	Description
`-q, --query`	`[]`	Additional query parameter as name=value. May be repeated.
`--session-file`		Read the ArchivesSpace session from this local file instead of process arguments. Defaults to ARCHIVESSPACE_SESSION_FILE or ARCHIVESSPACE_SESSION.
`--url`	`http://127.0.0.1:8089`	Base ArchivesSpace API URL reachable from the ArchivesSpace container.

Overview

ArchivesSpace

Drupal

Islandora

Omeka Classic

Omeka S

OJS

WordPress

Reference

`search`

`jobs`

`repositories`

​Reference

​search

​jobs

​repositories

Reference

`search`

`jobs`

`repositories`