Project¶
rio project¶
High-level groups for other resources
rio project [OPTIONS] COMMAND [ARGS]...
create¶
Create a new project.
If you do not specify the organization, the project will be created in the current organization.
rio project create [OPTIONS] PROJECT_NAME
Options
- --organization <organization_name>¶
Pass organization name for which project needs to be created. Default will be current organization
Arguments
- PROJECT_NAME¶
Required argument
delete¶
Delete a project.
You can skip the confirmation prompt by using the --force
or -f or the --silent flag.
rio project delete [OPTIONS] PROJECT_NAME
Options
- -f, --force, --silent¶
Skip confirmation
Arguments
- PROJECT_NAME¶
Required argument
features¶
Toggle features on a project
rio project features [OPTIONS] COMMAND [ARGS]...
dockercache¶
Enable or disable DockerCache on a project
Example:
rio project features dockercache [OPTIONS] PROJECT_NAME ENABLE
Options
- --proxy-device <proxy_device>¶
Name of the device for docker-cache proxy.
- --proxy-interface <proxy_interface>¶
Name of the network interface for docker-cache proxy.
- --registry-url <registry_url>¶
URL for the upstream docker registry.
- --registry-secret <registry_secret>¶
Name of the secret for upstream docker registry
- --data-directory <data_directory>¶
Registry data directory path
Arguments
- PROJECT_NAME¶
Required argument
- ENABLE¶
Required argument
vpn¶
Enable or disable VPN on a project
Example:
rio project features vpn “my-project” true
rio project features vpn “my-project” true –subnets 10.81.0.0/16
rio project features vpn [OPTIONS] PROJECT_NAME ENABLE
Options
- --subnets <subnets>¶
Subnet ranges for the project. For example: 10.81.0.0/16
Arguments
- PROJECT_NAME¶
Required argument
- ENABLE¶
Required argument
inspect¶
Print the project details.
You can specify the format of the output using the --format flag.
The supported formats are json and yaml. Default is yaml.
rio project inspect [OPTIONS] PROJECT_NAME
Options
- -f, --format <format_type>¶
- Options:
json | yaml
Arguments
- PROJECT_NAME¶
Required argument
list¶
List all the projects you are a part of in current organization.
You can also filter the list by specifying labels using the --label
or the -l flag.
For more details, you can use the --wide or the -w flag.
Usage Examples:
List all projects with label “release=3.0”
$ rio project list –label release=3.0
List projects with the wide option
$ rio project list –wide
rio project list [OPTIONS]
Options
- --organization <organization_name>¶
List projects for an organization
- -l, --label <labels>¶
Filter the deployment list by labels
- -w, --wide¶
Print more details
select¶
Switch to a different project in the current organization.
The project will be set in the CLI’s context and will be used for all the subsequent commands.
rio project select [OPTIONS] PROJECT_NAME
Arguments
- PROJECT_NAME¶
Required argument
update-owner¶
Update the owner of the project.
The command will show an interactive list of users in the project if
you do not specify --user-email. You can select the new owner from the list.
Usage Examples:
Update the owner of the project to a specific user
$ rio project update-owner PROJECT –user-email user@email.com
rio project update-owner [OPTIONS] PROJECT_NAME
Options
- --user-email <user_email>¶
Email of the new owner
Arguments
- PROJECT_NAME¶
Required argument
whoami¶
Find your role in a project.
If you do not specify the project name, the command will use the project set in the CLI context.
rio project whoami [OPTIONS]
Options
- -p, --project-name <project_name>¶