Login

It can be difficult to keep track of your API Access Keys. To help you manage your credentials, the login command saves your API Access Key with a profile. When possible, your profile will be inferred in other commands.

Usage

bunny-launcher login [options] <profile> <access-key>

Examples

bunny-launcher login personal c24347cf-1bc0-4900-8d60-86b1c7701f53
bunny-launcher login business 85e2e568-dc73-47c2-8530-ce8f8f42fe6c

  • Name
    profile
    Type
    string
    Description

    Profile

    Your profile is any easy-to-remember name that you give to reference your API Access Key. By saving an API Access Key under a profile, you can use that profile to easily select, change, and remove your API Access Key.

  • Name
    access-key
    Type
    uuid
    Description

    Access Key

    To find your account API Access Key, please visit either:

    • The new Dashboard > Profile picture > Edit account details > API Key
    • The old Panel > Account > API

    All account API Access Keys are in uuid format, such as c24347cf-1bc0-4900-8d60-86b1c7701f53.

    Please read the authentication guide to learn more about Access Key types.

  • Name
    --shared-credentials-file, -c
    Type
    file-path
    Description

    Shared Credentials File

    All profiles are saved by default in ~/.bunny/credentials.

    The shared credentials file follows the TOML v1.0.0 format specification.

    Each profile consists of a:

    • profile
    • accessKey
    • email
    • id
    • name (optional)

    Shared Credentials File sample

    [personal]
    accessKey = "c24347cf-1bc0-4900-8d60-86b1c7701f53"
    email = "johndoe@example.com"
    id = "31141ed7-9a4c-48b3-9910-676f9c999d70"
    
    [business]
    accessKey = "85e2e568-dc73-47c2-8530-ce8f8f42fe6c"
    email = "johndoe@company.com"
    id = "5552c462-bde1-4a41-88ed-d8c1bc1c51bc"
    name = "John Doe"