Manage Projects
This page details the immuta project command, its subcommands and arguments, and the workflow for creating, renaming, and deleting projects.
Command: immuta project
This command allows you to list, save, delete, and rename projects in your instance of Immuta. The table below illustrates subcommands and arguments.
Subcommands
Description
Argument(s)
Use these options to get more details about the project command or any of its subcommands:
Create Project: immuta project save
Required Immuta permission: CREATE_PROJECT
Add your project information in a valid YAML file for the V2 API. Additional payload examples for creating projects can :
Run the following referencing the file you just created: immuta project save <filepath> [--dryRun] [--deleteWorkSpaceDataSources] The options you can specify include
--deleteWorkSpaceDataSources
The example below illustrates a user listing all projects and then creating the project demo project.
Rename a Project Key: immuta project rename
Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project
Opt to list all project keys to identify which project you would like to rename by running immuta project list. Options you can specify include
-h or --help: Get more information about the command.
The example below illustrates a user renaming the demo project project key to data analytics team.
Delete a Project: immuta project delete
Requirement: You must be the owner of the project
Opt to list all project keys to determine which project key you would like to delete by running immuta project list. Options you can specify include
-h or --help: Get more information about the command.
The example below illustrates a user first disabling and then deleting the project Data Analytics Team.