CLI

frontier auth

Auth configs that need to be used with frontier

frontier completion [bash|zsh|fish|powershell]

Generate shell completion scripts

frontier config <command>

Manage client configurations

frontier config init

Initialize a new client configuration

frontier config list

List client configuration settings

frontier environment

List of supported environment variables

frontier export <kind>

Export the current state of a kind as a desired-state YAML file, printed to stdout. The output is the format frontier reconcile reads: reconciling it changes nothing. Supported kinds: PlatformUser, Permission, Role, Preference, Webhook, BillingProduct, BillingPlan, and MetaSchema. See the Reconcile guide for the file format and the flow.

$ frontier export platformuser -H "Authorization:Basic <base64>" > platform-users.yaml
-H, --header string   Header <key>:<value>

frontier group

Manage groups

frontier group create [flags]

Upsert a group

-f, --file string     Path to the group body file
-H, --header string   Header <key>:<value>

frontier group edit [flags]

Edit a group

-f, --file string   Path to the group body file

frontier group list

List all groups

frontier group view [flags]

View a group

-m, --metadata   Set this flag to see metadata

frontier namespace

Manage namespaces

frontier namespace list

List all namespaces

frontier namespace view

View a namespace

frontier organization

Manage organizations

frontier organization admlist

list admins of an organization

frontier organization create [flags]

Upsert an organization

-f, --file string     Path to the organization body file
-H, --header string   Header <key>:<value>

frontier organization edit [flags]

Edit an organization

-f, --file string   Path to the organization body file

frontier organization list

List all organizations

frontier organization view [flags]

View an organization

-m, --metadata   Set this flag to see metadata

frontier permission

Manage permissions

frontier permission create [flags]

Upsert a permission

-f, --file string     Path to the permission body file
-H, --header string   Header <key>:<value>

frontier permission edit [flags]

Edit a permission

-f, --file string   Path to the permission body file

frontier permission list

List all permissions

frontier permission view

View a permission

frontier policy

Manage policies

frontier policy create [flags]

Upsert a policy

-f, --file string     Path to the policy body file
-H, --header string   Header <key>:<value>

frontier policy edit [flags]

Edit a policy

-f, --file string   Path to the policy body file

frontier policy view

View a policy

frontier preferences

Preferences management

frontier preferences get [flags]

Get preference traits list

-H, --header string   Header <key>:<value>

frontier preferences list [flags]

list preferences

-H, --header string   Header <key>:<value>

frontier preferences set [flags]

Set value for a preference trait

-H, --header string   Header <key>:<value>
-n, --name string     Name of the preference
-v, --value string    Value of the preference

frontier project

Manage projects

frontier project create [flags]

Upsert a project

-f, --file string     Path to the project body file
-H, --header string   Header <key>:<value>

frontier project edit [flags]

Edit a project

-f, --file string   Path to the project body file

frontier project list

List all projects

frontier project view [flags]

View a project

-m, --metadata   Set this flag to see metadata

frontier reconcile [flags]

Make platform resources match a desired-state YAML file, through the admin API. Supported kinds: PlatformUser (anyone listed is added, anyone not listed is removed), Permission (custom permissions), Role (platform-level roles), Preference (platform settings, where a setting left out of the file resets to its default), Webhook (webhook endpoints), BillingProduct (billing products and their prices), BillingPlan (billing plans and the products they bundle), and MetaSchema (metadata validation schemas, where a schema left out resets to its shipped default). Deleting a permission, a custom role, or a webhook needs an explicit delete: true on its entry; nothing is deleted by omission, a predefined role cannot be deleted, and a billing product or plan cannot be deleted through the API. Use frontier export to print the current state in this file format, and see the Reconcile guide for the full flow.

$ frontier reconcile -f platform-users.yaml --dry-run -H "Authorization:Basic <base64>"
    --dry-run         Print the plan without applying changes
-f, --file string     Path to the desired-state YAML file
-H, --header string   Header <key>:<value>

frontier role

Manage roles

frontier role create [flags]

Upsert a role

-f, --file string     Path to the role body file
-H, --header string   Header <key>:<value>

frontier role edit [flags]

Edit a role

-f, --file string   Path to the role body file

frontier role list

List all roles

frontier role view [flags]

View a role

-m, --metadata   Set this flag to see metadata

frontier seed [flags]

Seed the database with initial data

-c, --config string   config file path
-H, --header string   Header <key>

frontier server

Server management

frontier server init [flags]

Initialize server

-o, --output string   Output config file path (default "./config.yaml")

frontier server keygen [flags]

Generate 2 rsa keys as jwks for auth token generation

-k, --keys int   num of keys to generate (default 2)

frontier server migrate [flags]

Run DB Schema Migrations

-c, --config string   config file path

frontier server migrate-rollback [flags]

Run DB Schema Migrations Rollback to last state

-c, --config string   config file path

frontier server start [flags]

Start server and proxy default on port 8080

-c, --config string   config file path

frontier user

Manage users

frontier user create [flags]

Upsert an user

-f, --file string     Path to the user body file
-H, --header string   Header <key>:<value>

frontier user edit [flags]

Edit an user

-f, --file string   Path to the user body file

frontier user list

List all users

frontier user view [flags]

View an user

-m, --metadata   Set this flag to see metadata

frontier version

Print version information