catalog init

Create a new catalog repository.

The destination comes from the catalog group’s selectors (-n/--name or -p/--path), supplied before the init subcommand. The command refuses to overwrite an existing catalog at the target path.

Usage

xorq catalog init [OPTIONS]

Options

Option Default Description
--env-file none Env file for the annex remote (for example .env.catalog.s3; mutually exclusive with –env-prefix).
--env-prefix none Env-var prefix for the annex remote (for example XORQ_CATALOG_S3_; mutually exclusive with –env-file).
--gcs off Apply GCS defaults to S3 config (annex remote or content store).
--content-store none Create a pointer catalog backed by directory, S3, or hosted storage.
--remote-url none Git remote URL (sets origin).

Examples

# Create a catalog at the default location for the name
xorq catalog --name analytics init
# Create at an explicit path with a git remote
xorq catalog --path ./catalogs/analytics init --remote-url git@github.com:acme/analytics-catalog.git
# Create with an S3-backed annex remote sourced from an env file
xorq catalog --name analytics init --env-file .env.catalog.s3
# Create a hosted pointer catalog using its service-provided ID and URL
xorq catalog --name analytics init --content-store presigned --remote-url https://catalog.example/acme/analytics.git

See also