Browse documentation

Core workflow

Projects and files

Organize durable paths, immutable versions, directory uploads, and downloads.

Before you start

  • Complete browser-approved CLI login.
  • Create a project or obtain access to an existing project.

Create and select projects

project setup
blobyard --workspace demo-team projects list blobyard --workspace demo-team projects create "Release files" blobyard init --workspace demo-team --project release-files

Project-local configuration supplies defaults for later commands. An explicit command flag still takes priority.

Upload files and directories

file and directory uploads
blobyard upload ./report.zip --path releases/report.zip blobyard upload ./dist
  • Directory uploads preserve safe relative paths.
  • Blob Yard respects .gitignore and .blobyardignore unless --include-ignored is set.
  • Uploading the same logical path creates a new immutable version.
  • Symbolic links are not followed.

Work with Blob Yard URIs

list, download, and remove
blobyard ls blobyard://demo-team/release-files/releases --versions blobyard download blobyard://demo-team/release-files/releases/report.zip?version=2 --output ./report.zip blobyard rm blobyard://demo-team/release-files/releases/old.zip

Reference and troubleshooting

Syntax and behavior

Reusable syntax

transfer syntax
blobyard --workspace <workspace-slug> --project <project-slug> upload <local-path> [--path <logical-path>] [--include-ignored] blobyard download <blobyard-uri> --output <local-path> [--force]

Concrete example

file upload and download
blobyard --workspace demo-team --project release-files upload ./report.zip --path releases/report.zip blobyard download blobyard://demo-team/release-files/releases/report.zip?version=2 --output ./downloaded-report.zip

Values used

./report.zip
Local source file on this machine.
releases/report.zip
Remote logical path stored as Blob Yard metadata.
blobyard://demo-team/release-files/releases/report.zip
Workspace, project, and logical-path segments of the remote URI.
?version=2
Selects immutable version 2. Omit it to use the current ready version.
./downloaded-report.zip
Local output path. --force permits replacing an existing file.

Expected result

Upload returns the canonical URI and version. Download writes byte-verified content to the chosen local output path.

If it fails

  • Use blobyard ls with the project scope to confirm the logical path and version.
  • Remove --path if the intended remote path should match the local basename.

Security and lifecycle

Transfers use short-lived signed URLs. Logical paths never become unvalidated physical storage keys.