flagship flag

Manage your flags

flagship flag create

NAME

flagship flag create - Create a flag

SYNOPSIS

flagship flag create [--name NAME --type TYPE --default-value DEFAULT_VALUE --description DESCRIPTION --predefined-values PREDEFINED_VALUES | [-d DATA_RAW | --data-raw = DATA_RAW]]

DESCRIPTION

    Create a flag in your account

EXAMPLES

flagship flag create -d DATA_RAW
flagship flag create -d "{\"name\":\"CLI_flag\",\"type\":\"string\",\"source\":\"manual\",\"description\":\"Flag created with the Flagship CLI\",\"default_value\":\"DEFAULT_VALUE\",\"predefined_values\":[\"Value_1\",\"Value_2\"]}"
flagship flag create --name "CLI_flag" --type "string" --description "Flag created with the Flagship CLI" --default-value "DEFAULT_VALUE" --predefined-values "[\"Value_1\",\"Value_2\"]"

FLAGS

--name = NAME

Name of the flag

--type = TYPE

Type of the flag

--description = DESCRIPTION

Description of the flag

--default-value = DEFAULT_VALUE

Default value of the flag

--predefined-values = PREDEFINED_VALUES

Predefined valued for the flag

🚧

--data-raw flag has priority over the others flags (--name, --type etc...)

If you insert --data-raw with the other flags (--name, --type etc...) the data inside --data-raw will override the others.

--data-raw = DATA_RAW

    The raw data contains all the info to create your flag, check the Remote Control documentation for more details

❗️

Raw data format

Note that you should insert data without spaces, line breaks, tabulation etc...


flagship flag list

NAME

flagship flag list - List all flags

SYNOPSIS

flagship flag list [--output-format = OUTPUT_FORMAT [table|json|json-pretty]]

DESCRIPTION

    List all flags in your account

EXAMPLES

flagship flag list

FLAGS

--output-format = OUTPUT_FORMAT

    The output format for printing command output resources. The default is table. The supported formats are: json-pretty, table, json.


flagship flag get

NAME

flagship flag get - Get a flag

SYNOPSIS

flagship flag get [-i FLAG_ID | --id = FLAG_ID]

DESCRIPTION

    Get a flag in your account

EXAMPLES

flagship flag get -i FLAG_ID

REQUIRED FLAGS

--id = FLAG_ID

    The id of the flag you want to display

FLAGS

--output-format OUTPUT_FORMAT

    The output format for printing command output resources. The default is table. The supported formats are: json-pretty, table, json.


flagship flag edit

NAME

flagship flag edit - Edit a flag

SYNOPSIS

flagship flag edit [-i FLAG_ID | --id = FLAG_ID] [-d DATA_RAW | --data-raw = DATA_RAW ]

DESCRIPTION

    Edit a flag in your account

EXAMPLES

flagship flag edit -i FLAG_ID -d DATA_RAW

REQUIRED FLAGS

--id = FLAG_ID

    The id of the flag you want to edit

--data-raw = DATA_RAW

    The raw data contains all the info to edit your flag, check the Remote Control documentation for more details

❗️

Raw data format

Note that you should insert data without spaces, line breaks, tabulation etc...


flagship flag delete

NAME

flagship flag delete - Delete a flag

SYNOPSIS

flagship flag delete [-i FLAG_ID | --id = FLAG_ID]

DESCRIPTION

    Delete a flag in your account

EXAMPLES

flagship flag delete -i FLAG_ID

REQUIRED FLAGS

--id = FLAG_ID

    The id of the flag you want to delete


flagship flag usage get

NAME

flagship flag usage get - List all flag usage statistics inside your codebase

SYNOPSIS

flagship flag usage get

DESCRIPTION

    List all flag usage statistics inside your codebase in your account

EXAMPLES

flagship flag usage get

FLAGS

--output-format OUTPUT_FORMAT

    The output format for printing command output resources. The default is table. The supported formats are: json-pretty, table, json.