examples/

OCFL Examples

This directory contains runnable Go examples for common OCFL operations using the gocfl library. These examples are based on the Quickstart Guide.

Examples

1. Storage Root Initialization
   • Demonstrates how to initialize a new OCFL Storage Root.
2. Object Creation
   • Demonstrates how to create and initialize a new OCFL Object within a storage root.
3. Adding and Updating Content
   • Demonstrates how to add files to an object and create subsequent versions with updated content.
4. Object Validation
   • Demonstrates how to validate an existing OCFL Object.
5. Extracting Objects
   • Demonstrates how to extract the content of an OCFL Object to a destination filesystem.

How to Run

Each example is a self-contained Go program that uses the local filesystem. You need to provide the path to the OCFL Storage Root via the -path parameter (and the Object ID via -id), or use the -objectpath parameter to point directly to an OCFL Object.

# 1. Initialize a Storage Root
go run github.com/ocfl-archive/gocfl/v3/examples/storageroot_init@latest -path ./my-storage-root

# 2. Create an Object
go run github.com/ocfl-archive/gocfl/v3/examples/object_add@latest -path ./my-storage-root -id my-object-1

# 3. Add and Update Content
go run github.com/ocfl-archive/gocfl/v3/examples/object_upd@latest -path ./my-storage-root -id my-object-1

# 4. Validate an Object
go run github.com/ocfl-archive/gocfl/v3/examples/object_validate@latest -path ./my-storage-root -id my-object-1

# 5. Extract an Object
go run github.com/ocfl-archive/gocfl/v3/examples/object_extract@latest -path ./my-storage-root -id my-object-1 -dest ./extraction-dir

Parameters

• -path: Absolute or relative path to the OCFL Storage Root.
• -id: (Optional for most) The OCFL Object ID to create, update, or extract. Defaults to my-object-id.
• -objectpath: (Alternative to -path and -id) Direct path to an OCFL Object directory. If used, -path is not required.
• -dest: (For extraction only) The destination directory where the object content will be extracted.

Note on Filesystems

These examples use vfsrw with the os backend to interact with your local filesystem. You can use these examples as a starting point for building your own OCFL-aware applications.