CLI documentation

rebrickable

Rebrickable CLI implemented in Python

rebrickable [OPTIONS] COMMAND [ARGS]...

Options

-o, --output <output>

output printer (json, yaml, py –regular print Python function–)

Options

json|py|yaml

data

data commands

rebrickable data [OPTIONS] COMMAND [ARGS]...

download

rebrickable data download [OPTIONS]

Options

--force

force to overwrite existing file(s)

download-extra

rebrickable data download-extra [OPTIONS]

import

rebrickable data import [OPTIONS]

Options

--force

force to overwrite existing data in the database

reset-db

rebrickable data reset-db [OPTIONS]

lego

LEGO data (parts, sets, themes, etc.)

rebrickable lego [OPTIONS] COMMAND [ARGS]...

color

rebrickable lego color [OPTIONS] COLOR_ID COMMAND [ARGS]...

Arguments

COLOR_ID

Required argument

external_ids
rebrickable lego color external_ids [OPTIONS]
id
rebrickable lego color id [OPTIONS]
is_trans
rebrickable lego color is_trans [OPTIONS]
name
rebrickable lego color name [OPTIONS]
rgb
rebrickable lego color rgb [OPTIONS]

colors

rebrickable lego colors [OPTIONS]

element

rebrickable lego element [OPTIONS] ELEMENT_ID COMMAND [ARGS]...

Arguments

ELEMENT_ID

Required argument

color
rebrickable lego element color [OPTIONS]
design_id
rebrickable lego element design_id [OPTIONS]
element_id
rebrickable lego element element_id [OPTIONS]
element_img_url
rebrickable lego element element_img_url [OPTIONS]
part
rebrickable lego element part [OPTIONS]
part_img_url
rebrickable lego element part_img_url [OPTIONS]

moc

rebrickable lego moc [OPTIONS] SET_NUM COMMAND [ARGS]...

Arguments

SET_NUM

Required argument

designer_name
rebrickable lego moc designer_name [OPTIONS]
designer_url
rebrickable lego moc designer_url [OPTIONS]
moc_img_url
rebrickable lego moc moc_img_url [OPTIONS]
moc_url
rebrickable lego moc moc_url [OPTIONS]
name
rebrickable lego moc name [OPTIONS]
num_parts
rebrickable lego moc num_parts [OPTIONS]
parts
rebrickable lego moc parts [OPTIONS]
set_num
rebrickable lego moc set_num [OPTIONS]
theme_id
rebrickable lego moc theme_id [OPTIONS]
year
rebrickable lego moc year [OPTIONS]

part

rebrickable lego part [OPTIONS] PART_NUM COMMAND [ARGS]...

Arguments

PART_NUM

Required argument

alternates
rebrickable lego part alternates [OPTIONS]
color
rebrickable lego part color [OPTIONS] COLOR_ID COMMAND [ARGS]...

Arguments

COLOR_ID

Required argument

elements
rebrickable lego part color elements [OPTIONS]
num_set_parts
rebrickable lego part color num_set_parts [OPTIONS]
num_sets
rebrickable lego part color num_sets [OPTIONS]
part_img_url
rebrickable lego part color part_img_url [OPTIONS]
sets
rebrickable lego part color sets [OPTIONS]
year_from
rebrickable lego part color year_from [OPTIONS]
year_to
rebrickable lego part color year_to [OPTIONS]
colors
rebrickable lego part colors [OPTIONS]
external_ids
rebrickable lego part external_ids [OPTIONS]
molds
rebrickable lego part molds [OPTIONS]
name
rebrickable lego part name [OPTIONS]
part_cat_id
rebrickable lego part part_cat_id [OPTIONS]
part_img_url
rebrickable lego part part_img_url [OPTIONS]
part_num
rebrickable lego part part_num [OPTIONS]
part_url
rebrickable lego part part_url [OPTIONS]
print_of
rebrickable lego part print_of [OPTIONS]
prints
rebrickable lego part prints [OPTIONS]
year_from
rebrickable lego part year_from [OPTIONS]
year_to
rebrickable lego part year_to [OPTIONS]

part_categories

rebrickable lego part_categories [OPTIONS]

part_category

rebrickable lego part_category [OPTIONS] ID COMMAND [ARGS]...

Arguments

ID

Required argument

id
rebrickable lego part_category id [OPTIONS]
name
rebrickable lego part_category name [OPTIONS]
part_count
rebrickable lego part_category part_count [OPTIONS]

parts

rebrickable lego parts [OPTIONS]

set

rebrickable lego set [OPTIONS] SET_NUM COMMAND [ARGS]...

Arguments

SET_NUM

Required argument

alternates
rebrickable lego set alternates [OPTIONS]
last_modified_dt
rebrickable lego set last_modified_dt [OPTIONS]
name
rebrickable lego set name [OPTIONS]
num_parts
rebrickable lego set num_parts [OPTIONS]
parts
rebrickable lego set parts [OPTIONS]
set_img_url
rebrickable lego set set_img_url [OPTIONS]
set_num
rebrickable lego set set_num [OPTIONS]
set_url
rebrickable lego set set_url [OPTIONS]
sets
rebrickable lego set sets [OPTIONS]
theme_id
rebrickable lego set theme_id [OPTIONS]
year
rebrickable lego set year [OPTIONS]

sets

rebrickable lego sets [OPTIONS]

theme

rebrickable lego theme [OPTIONS] THEME_ID COMMAND [ARGS]...

Arguments

THEME_ID

Required argument

id
rebrickable lego theme id [OPTIONS]
name
rebrickable lego theme name [OPTIONS]
parent_id
rebrickable lego theme parent_id [OPTIONS]

themes

rebrickable lego themes [OPTIONS]

login

login a certain user (store its user token)

rebrickable login [OPTIONS] [USERNAME]

Arguments

USERNAME

Optional argument

register

registers an API key with the CLI

rebrickable register [OPTIONS]

user

user data (sets, parts lists, set lists, etc.)

rebrickable user [OPTIONS] COMMAND [ARGS]...

Options

-u, --username <username>

allparts

rebrickable user allparts [OPTIONS]

build

rebrickable user build [OPTIONS] SET_NUM COMMAND [ARGS]...

Arguments

SET_NUM

Required argument

build_options
rebrickable user build build_options [OPTIONS]
num_ignored
rebrickable user build num_ignored [OPTIONS]
num_missing
rebrickable user build num_missing [OPTIONS]
num_owned_less_ignored
rebrickable user build num_owned_less_ignored [OPTIONS]
pct_owned
rebrickable user build pct_owned [OPTIONS]
total_parts
rebrickable user build total_parts [OPTIONS]
total_parts_less_ignored
rebrickable user build total_parts_less_ignored [OPTIONS]

lost_parts

rebrickable user lost_parts [OPTIONS] COMMAND [ARGS]...
create
rebrickable user lost_parts create [OPTIONS] INV_PART_ID

Arguments

INV_PART_ID

Required argument

delete
rebrickable user lost_parts delete [OPTIONS] LOST_PART_ID

Arguments

LOST_PART_ID

Required argument

list
rebrickable user lost_parts list [OPTIONS]

partlist

rebrickable user partlist [OPTIONS] LIST_ID COMMAND [ARGS]...

Arguments

LIST_ID

Required argument

delete
rebrickable user partlist delete [OPTIONS]
id
rebrickable user partlist id [OPTIONS]
is_buildable
rebrickable user partlist is_buildable [OPTIONS]
name
rebrickable user partlist name [OPTIONS]
num_parts
rebrickable user partlist num_parts [OPTIONS]
part
rebrickable user partlist part [OPTIONS] COLOR_ID PART_NUM COMMAND [ARGS]...

Arguments

COLOR_ID

Required argument

PART_NUM

Required argument

id
rebrickable user partlist part id [OPTIONS]
is_buildable
rebrickable user partlist part is_buildable [OPTIONS]
name
rebrickable user partlist part name [OPTIONS]
num_parts
rebrickable user partlist part num_parts [OPTIONS]
update
rebrickable user partlist part update [OPTIONS] QUANTITY

Arguments

QUANTITY

Required argument

partial_update
rebrickable user partlist partial_update [OPTIONS]

Options

--name <name>
--is_buildable <is_buildable>
--num_parts <num_parts>
parts
rebrickable user partlist parts [OPTIONS] COMMAND [ARGS]...
create
rebrickable user partlist parts create [OPTIONS] PART_NUM QUANTITY COLOR_ID

Arguments

PART_NUM

Required argument

QUANTITY

Required argument

COLOR_ID

Required argument

delete
rebrickable user partlist parts delete [OPTIONS] COLOR_ID PART_NUM

Arguments

COLOR_ID

Required argument

PART_NUM

Required argument

list
rebrickable user partlist parts list [OPTIONS]
update
rebrickable user partlist update [OPTIONS] NAME

Arguments

NAME

Required argument

partlists

rebrickable user partlists [OPTIONS] COMMAND [ARGS]...
create
rebrickable user partlists create [OPTIONS] NAME

Arguments

NAME

Required argument

list
rebrickable user partlists list [OPTIONS]

parts

rebrickable user parts [OPTIONS]

profile

rebrickable user profile [OPTIONS] COMMAND [ARGS]...
avatar_img
rebrickable user profile avatar_img [OPTIONS]
email
rebrickable user profile email [OPTIONS]
last_activity
rebrickable user profile last_activity [OPTIONS]
last_ip
rebrickable user profile last_ip [OPTIONS]
lego
rebrickable user profile lego [OPTIONS]
location
rebrickable user profile location [OPTIONS]
real_name
rebrickable user profile real_name [OPTIONS]
rewards
rebrickable user profile rewards [OPTIONS]
user_id
rebrickable user profile user_id [OPTIONS]
username
rebrickable user profile username [OPTIONS]

set

rebrickable user set [OPTIONS] SET_NUM COMMAND [ARGS]...

Arguments

SET_NUM

Required argument

delete
rebrickable user set delete [OPTIONS]
include_spares
rebrickable user set include_spares [OPTIONS]
list_id
rebrickable user set list_id [OPTIONS]
quantity
rebrickable user set quantity [OPTIONS]
set
rebrickable user set set [OPTIONS]
set_num
rebrickable user set set_num [OPTIONS]
sync
rebrickable user set sync [OPTIONS]

setlist

rebrickable user setlist [OPTIONS] LIST_ID COMMAND [ARGS]...

Arguments

LIST_ID

Required argument

delete
rebrickable user setlist delete [OPTIONS]
id
rebrickable user setlist id [OPTIONS]
is_buildable
rebrickable user setlist is_buildable [OPTIONS]
name
rebrickable user setlist name [OPTIONS]
num_sets
rebrickable user setlist num_sets [OPTIONS]
partial
rebrickable user setlist partial [OPTIONS] COMMAND [ARGS]...
set
rebrickable user setlist set [OPTIONS] SET_NUM COMMAND [ARGS]...

Arguments

SET_NUM

Required argument

include_spares
rebrickable user setlist set include_spares [OPTIONS]
list_id
rebrickable user setlist set list_id [OPTIONS]
quantity
rebrickable user setlist set quantity [OPTIONS]
set
rebrickable user setlist set set [OPTIONS]
set_num
rebrickable user setlist set set_num [OPTIONS]
sets
rebrickable user setlist sets [OPTIONS] COMMAND [ARGS]...
create
rebrickable user setlist sets create [OPTIONS] SET_NUM

Arguments

SET_NUM

Required argument

delete
rebrickable user setlist sets delete [OPTIONS]
list
rebrickable user setlist sets list [OPTIONS]
update
rebrickable user setlist sets update [OPTIONS]
user-setlists-sets-partial
rebrickable user setlist sets user-setlists-sets-partial [OPTIONS] COMMAND
                                                         [ARGS]...
update
rebrickable user setlist sets user-setlists-sets-partial update 
    [OPTIONS] SET_NUM

Arguments

SET_NUM

Required argument

update
rebrickable user setlist update [OPTIONS] NAME

Arguments

NAME

Required argument

setlists

rebrickable user setlists [OPTIONS] COMMAND [ARGS]...
create
rebrickable user setlists create [OPTIONS] NAME

Arguments

NAME

Required argument

list
rebrickable user setlists list [OPTIONS]

sets

rebrickable user sets [OPTIONS] COMMAND [ARGS]...
create
rebrickable user sets create [OPTIONS] SET_NUM

Arguments

SET_NUM

Required argument

list
rebrickable user sets list [OPTIONS]

Options

--set_num <set_num>
--theme_id <theme_id>
--min_year <min_year>
--max_year <max_year>
--min_parts <min_parts>
--max_parts <max_parts>
sync
rebrickable user sets sync [OPTIONS]

Options

-f, --file <file>

users

users-related data (global badge information)

rebrickable users [OPTIONS] COMMAND [ARGS]...

badge

rebrickable users badge [OPTIONS] BADGE_ID COMMAND [ARGS]...

Arguments

BADGE_ID

Required argument

code
rebrickable users badge code [OPTIONS]
descr
rebrickable users badge descr [OPTIONS]
id
rebrickable users badge id [OPTIONS]
level
rebrickable users badge level [OPTIONS]
name
rebrickable users badge name [OPTIONS]

badges

rebrickable users badges [OPTIONS]

Indices and tables