Repositories

queenbee repository

manage package repositories

A Queenbee repository is a folder containing packaged Plugins and Recipes. This folder contains an Index file (index.json) that can be used to find specific packages as well as track some metadata such as version, creation date and most importantly the hash digest of the package.

A repository folder should be written using a specific folder structure as shown below:


.
├── plugins
│   ├── some-plugin-1.0.0.tgz
│   ├── some-plugin-1.3.5.tgz
│   └── another-plugin-1.2.3.tgz
├── recipes
│   └── my-recipe-0.0.1.tgz
└── index.json

You can use the commands documented below to help you manage a repository

queenbee repository [OPTIONS] COMMAND [ARGS]...

add

add a package repository

Use this command to add a repository to your local index. This is useful to search, develop and use queenbee packages locally.

queenbee repository add [OPTIONS] NAME PATH

Options

-f, --force

Boolean toggle to overwrite existing repository with same name

Arguments

NAME

Required argument

PATH

Required argument

get

get and print a specific package

Use this command to print out a specific package version from a given repository.

type: Package type. It should be either a plugin or a repository.

repo: The name of the repository.

name: Name of the package.

queenbee repository get [OPTIONS] TYPE REPO NAME

Options

-t, --tag <tag>

Package tag.

Arguments

TYPE

Required argument

REPO

Required argument

NAME

Required argument

index

index the repository folder

Use this command to crawl a repository folder and update/regenerate an index.json file.

queenbee repository index [OPTIONS] PATH

Options

-i, --index <index_path>

Path to the index file to read/write to

-n, --new

Delete previous index and generate a new one from scratch

-f, --force

Overwrite existing package entries is digest hash does not match

-s, --skip

Skip any packages that would otherwise be overwritten

Arguments

PATH

Required argument

init

initialize an empty repository

Use this command to create a new repository folder.

queenbee repository init [OPTIONS] PATH

Arguments

PATH

Required argument

list

list the repositories saved in your local index

queenbee repository list [OPTIONS]

remove

remove a package repository

Use this command to remove a repository from your local index.

queenbee repository remove [OPTIONS] NAME

Arguments

NAME

Required argument

search

search for packages inside a repository

Use this command to search for packages inside of one of the repositories indexed on the user’s machine.

queenbee repository search [OPTIONS]

Options

-r, --repository <repository>

Only search within the named repository

-t, --type <kind>

Only search for a certain type of package

-s, --search <search>

A search query

serve

serve a local repository folder

Use this command to serve a local repository. You can then use “http://localhost:8000” as a source url to resolve your recipe dependencies.

queenbee repository serve [OPTIONS] PATH

Options

-p, --port <port>

The port to expose

Default:

8000

-a, --address <address>

The host addres to use

Default:

0.0.0.0

Arguments

PATH

Required argument