CLI

EmbedHub has a CLI that allows you to upload releases, PDFs, photos to your project. This can be done from your computer, or your CI environment like GitHub Actions or GitLab Runners.

CLI Installation

Download link will be available when we are out of beta!

• Install and verify installation: embedhub help

• Configure the API Key Obtain your API key from the "Embedhub user settings" section.

• Set up the API key

• Verify configuration

• Start uploading documents to your project

EmbedHub CLI is a command-line tool for uploading files
to your EmbedHub projects using API keys.

Examples:
  embedhub config set api-key YOUR_API_KEY
  embedhub config get api-key
  embedhub push app.zip myproject --path releases/v1.0.0/

Usage:
  embedhub [command]

Available Commands:
  config      Manage configuration settings
  help        Help about any command
  push        Upload a file or folder to an EmbedHub project

Flags:
      --api-key string   EmbedHub API key
      --config string    config file (default is $HOME/.embedhub/config.yaml)
  -h, --help             help for embedhub
      --verbose          verbose output

Use "embedhub [command] --help" for more information about a command.

Upload files

You can upload and categorize project files using CLI.

Supported file types

EmbedHub supports various file types, which are automatically sorted into the appropriate sections upon upload:

File Category	Supported File Extensions	Destination Section	Primary Purpose
Photos	.jpg, .jpeg, .png, .svg, .webp, .gif	photos	Visual assets, graphics, and images.
Documents	.pdf	documents	User guides, technical specifications, and other documents.
Releases	.bin, .map, .elf	releases	Firmware, compiled binaries, and mapping files for specific software releases.

To upload a file named app.zip to the my-org organization and my-project project, for the release version v1.0.0, you would use.

To simplify bulk uploads, EmbedHub automatically processes .zip files if they contain .pdf documents. Your .zip folder also stays in the path you added.

Example:

embedhub push path_to_file/app.zip my-org/my-project --path releases/v1.0.0/

EmbedHub simplifies file management by automatically placing uploaded files into the correct top-level section based on the file extension.

If you do not specify a custom path (using the --path option), your files will be placed into the root-level folder for their category.