Browse documentation

Start here

Getting started

Create a project, connect the CLI, upload a real file, and hand it off safely.

Before you start

  • Use macOS or Linux on a supported release architecture.
  • Have a browser that can sign in to blobyard.com.

Understand the model

Blob Yard stores any file type. A stored file remains available until you delete it or a matching retention policy removes it. Expiring access does not remove the stored file.

  • A workspace contains members, projects, plan limits, and audit history.
  • A project groups logical file paths, immutable versions, shares, previews, and retention.
  • A blobyard:// URI identifies a durable object or one immutable version.

Install and sign in

install and approve this machine
curl -fsSL https://blobyard.dev/install.sh | sh blobyard login blobyard whoami

The installer verifies and places the standalone binary, login opens browser approval, and whoami prints your identity with your workspace slug. You will need that slug in the next step.

Store your first file

create and upload
blobyard --workspace demo-team projects create "Release files" blobyard init --workspace demo-team --project release-files blobyard upload ./your-file.zip

Replace demo-team with the workspace slug whoami printed. init stores the workspace and project in .blobyard.toml, so upload and every later command in this directory needs no scope flags.

Create a controlled handoff

create a share
blobyard share blobyard://demo-team/release-files/your-file.zip --expires 7d

Share the blobyard:// URI that upload returned. The public URL is shown once. Its expiry controls access only, so the uploaded file stays in the project.

Reference and troubleshooting

Syntax and behavior

Reusable syntax

reusable first-file workflow
curl -fsSL https://blobyard.dev/install.sh | sh blobyard login blobyard --workspace <workspace-slug> projects create <name> blobyard init --workspace <workspace-slug> --project <project-slug> blobyard upload <local-path> blobyard share <blobyard-uri> --expires <duration>

Concrete example

concrete first-file workflow
curl -fsSL https://blobyard.dev/install.sh | sh blobyard login blobyard --workspace demo-team projects create "Release files" blobyard init --workspace demo-team --project release-files blobyard upload ./report.zip blobyard share blobyard://demo-team/release-files/report.zip --expires 7d

Values used

demo-team
Remote workspace slug printed by whoami and shown in the dashboard.
Release files
Human-readable project name. Blob Yard derives the release-files slug.
init
Writes .blobyard.toml so later commands in this directory need no scope flags.
./report.zip
Local file relative to the current shell directory.
7d
Share lifetime of seven days. It does not set file retention.

Expected result

The upload returns a blobyard:// URI. The share command returns one public URL for the uploaded version.

If it fails

  • Run blobyard whoami if authentication or workspace selection fails.
  • Run blobyard projects list with the same --workspace value to confirm the project slug.

Security and lifecycle

The file is durable by default. The public share expires, while the stored file remains until deletion or retention removes it.