Basic functionality
To get a full list of commands available in Ory CLI, run this command:
ory help
This prints the list of available commands with short descriptions. Additionally, each commands accepts the --help flag. Use it
to get more information about the command, available command-specific flags and command modifiers. For example:
ory auth --help
Create an or sign into your Ory Network account
Usage:
ory auth [flags]
ory auth [command]
Available Commands:
logout Signs you out of your account on this computer.
Flags:
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of table, json, and json-pretty. (default "default")
-h, --help help for auth
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
Use "ory auth [command] --help" for more information about a command.
Visit the Reference section to view all commands, flags, and options available in the Ory CLI. This documentation is generated automatically from the CLI source code.
Create Ory Network account and project
With Ory CLI, you can create a new Ory Network account and project from your terminal.
Follow these steps:
Run this command to start the wizard:
ory authIf you haven't signed in with the CLI before, you're asked if you have an Ory Network account.
Do you already have an Ory Console account you wish to use? [y/n]: nAnswer "no" to create a new account. In the process, you must provide the basic account information: email address, password, user name, and choose if you want to be informed about platform security updates.
As a final step, accept the Terms of Service.
I accept the Terms of Service https://www.ory.sh/ptos: [y/n]: yWhen the process is completed, the CLI displays the details of the created account and the ID of the currently selected project:
You are now signed in as: tom@email.com
ID cae666dg-2ffa-491b-9912-6b090ec10e1c
EMAIL tom@email.com
SELECTED_PROJECT 00000000-0000-0000-0000-000000000000
By default, no projects are associated with new accounts created through the Ory CLI. To create a new project, use the CLI or the Ory Console.
Create a project
Run this command to create a new project:
ory create project
When the operation is successful, the system returns the details of the newly created project:
Project created successfully!
ID 5e2281bd-e094-87b5-9d76-812ce4a9cfb3
SLUG twisty-galois-kz61jdc42q
STATE running
NAME My Amazing Project
Use CLI with existing account
Sign in to use the CLI with your existing Ory Network account and project.
Run this command to start the wizard:
ory authIf you haven't signed in with the CLI before, you're asked if you have an Ory Network account.
Do you already have an Ory Console account you wish to use? [y/n]: nFollow the on-screen instructions to sign in to your account.
infoIf you created your Ory Network account with a social sign-in provider, you must adjust the account configuration to use the CLI. Read this section for more information.
Upon successful sign in, the CLI shows the details of the signed-in user and the selected project:
You are now signed in as: john.wick@company.com
ID 7759555-e23a-44b7-b148-7fed7f908024
EMAIL john.wick@company.com
SELECTED_PROJECT 00000000-0000-0000-0000-000000000000
Accounts with social sign-in
If you created your account through a social sign-in provider such as GitHub or Google, you must adjust your account configuration to use the Ory CLI.
Accounts created with social sign-in providers don't use passwords. To use your account with Ory CLI, your account must have a password.
Follow these steps to create a password for an account created with a social sign-in provider:
- Open the Ory Console and sign in.
- Go to your account settings.
- Enter a new password in the Update Password field.
- Click Save to finish.