Project
Manage a project.
opal project <CREDENTIALS> [OPTIONS] [EXTRAS]
Options
Option |
Description |
---|---|
|
Project name. If no name and no action is specified, the list of the projects will be returned. |
|
Delete the project specified by the –name option |
|
Skip confirmation on project deletion |
|
Add a project specified by the –name option |
|
Name of the database to be associated to the project at creation time (optional, unless you intend to import data). |
|
The project’s title at creation time (optional). |
|
The project’s description at creation time (optional). |
|
The project tags at creation time (optional, separated by space). |
|
The project’s preferred export folder (optional). |
Credentials
Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).
Option |
Description |
---|---|
|
Opal server base url |
|
Credentials auth: user name (requires a password) |
|
Credentials auth: user password (requires a user name) |
|
Token auth: user’s personal access token |
|
Two-way SSL auth: certificate/public key file (requires a private key) |
|
Two-way SSL auth: private key file (requires a certificate) |
Extras
Option |
Description |
---|---|
|
Show the command help’s message. |
|
Verbose output. |
|
Output pretty-print JSON |
Example
Get the list of projects with pretty JSON formatted output:
opal project --opal https://opal-demo.obiba.org --user administrator --password password --json
Get a specific project:
opal project --opal https://opal-demo.obiba.org --user administrator --password password --name CNSIM
Create the project foo without associated database:
opal project --opal https://opal-demo.obiba.org --user administrator --password password --add --name foo
Delete the project foo:
opal project --opal https://opal-demo.obiba.org --user administrator --password password --delete --name foo