Opal allows you to centrally manage access to all of your sensitive systems.
npm install opal-securityOpal allows you to centrally manage access to all of your sensitive systems.





``sh-session`
$ npm install -g opal-security
$ opal COMMAND
running command...
$ opal (--version)
opal-security/5.1.0 darwin-arm64 node-v18.20.4
$ opal --help [COMMAND]
USAGE
$ opal COMMAND
...
* [opal autocomplete [SHELL]](#opal-autocomplete-shell)opal aws identity
* opal clear-auth-config
* opal curl-example
* opal groups get
* opal help [COMMANDS]
* [](#opal-help-commands)opal iam-roles start
* opal kube-roles start
* opal login
* opal logout
* opal postgres-instances start
* opal request create
* opal request get
* opal request list
* opal request ls
* opal resources get
* opal set-auth-config
* opal set-custom-header
* opal set-token
* opal set-url [URL]
* [](#opal-set-url-url)opal ssh copyFrom
* opal ssh copyTo
* opal ssh start
* opal version
* opal whoami
*
display autocomplete installation instructions
`
USAGE
$ opal autocomplete [SHELL] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ opal autocomplete
$ opal autocomplete bash
$ opal autocomplete zsh
$ opal autocomplete --refresh-cache
`
_See code: @oclif/plugin-autocomplete_
Gets the current caller identity for the "opal" AWS profile.
`
USAGE
$ opal aws identity [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Gets the current caller identity for the "opal" AWS profile.
EXAMPLES
$ opal aws:identity
`
_See code: src/commands/aws/identity.ts_
Clear all authentication configuration values
`
USAGE
$ opal clear-auth-config
DESCRIPTION
Clear all authentication configuration values
EXAMPLES
$ opal clear-auth-config
`
_See code: src/commands/clear-auth-config.ts_
Prints out an example cURL command containing the parameters the CLI uses to query the Opal server.
`
USAGE
$ opal curl-example [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Prints out an example cURL command containing the parameters the CLI uses to query the Opal server.
`
_See code: src/commands/curl-example.ts_
Get group info for a particular group.
`
USAGE
$ opal groups get [-h] [-i
FLAGS
-h, --help Show CLI help.
-i, --id=
DESCRIPTION
Get group info for a particular group.
EXAMPLES
$ opal groups:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
`
_See code: src/commands/groups/get.ts_
Display help for opal.
`
USAGE
$ opal help [COMMANDS...] [-n]
ARGUMENTS
COMMANDS... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for opal.
`
_See code: @oclif/plugin-help_
Starts a session to assume an IAM role.
`
USAGE
$ opal iam-roles start [-h] [-i
FLAGS
-h, --help Show CLI help.
-i, --id=
https://opal.dev/resources/[ID]
--profileName=
DESCRIPTION
Starts a session to assume an IAM role.
EXAMPLES
$ opal iam-roles:start
$ opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398
$ opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName "custom-profile"
`
_See code: src/commands/iam-roles/start.ts_
Starts a session to assume a Kubernetes cluster IAM role.
`
USAGE
$ opal kube-roles start [-h] [-i
FLAGS
-a, --accessLevelRemoteId=
-h, --help Show CLI help.
-i, --id=
https://opal.dev/resources/[ID]
DESCRIPTION
Starts a session to assume a Kubernetes cluster IAM role.
EXAMPLES
$ opal kube-roles:start
$ opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398
$ opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId "arn:aws:iam::712234975475:role/acme-eks-cluster-admin-role"
`
_See code: src/commands/kube-roles/start.ts_
Authenticates you with the Opal server.
`
USAGE
$ opal login [-h] [--email
FLAGS
-h, --help Show CLI help.
--email=
DESCRIPTION
Authenticates you with the Opal server.
EXAMPLES
$ opal login
`
_See code: src/commands/login.ts_
Clears locally stored Opal server authentication credentials.
`
USAGE
$ opal logout [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Clears locally stored Opal server authentication credentials.
EXAMPLES
$ opal logout
`
_See code: src/commands/logout.ts_
Starts a session to connect to a Postgres database.
`
USAGE
$ opal postgres-instances start [-h] [-i
FLAGS
-a, --accessLevelRemoteId=
-h, --help Show CLI help.
-i, --id=
https://opal.dev/resources/[ID]
--action=
DESCRIPTION
Starts a session to connect to a Postgres database.
EXAMPLES
$ opal postgres-instances:start
$ opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398
$ opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId fullaccess
$ opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId fullaccess --action view
`
_See code: src/commands/postgres-instances/start.ts_
Creates an Opal access request via an interactive form
`
USAGE
$ opal request create [-h] [-a
FLAGS
-a, --assets=
colon if needed, e.g. --assets 123:456.
If not provided, an interactive selection flow will be available to select assets to request.
-b, --bundle=
-d, --duration=
not provided, you will be prompted.
-h, --help Show CLI help.
-r, --reason=
-t, --template=
request based on the completed request.
DESCRIPTION
Creates an Opal access request via an interactive form
`
_See code: src/commands/request/create.ts_
Fetch details of an access request by request ID
`
USAGE
$ opal request get [-h] [-i
FLAGS
-h, --help Show CLI help.
-i, --id=
-v, --verbose Enable verbose output, prints full response in JSON format. Defaults to false.
DESCRIPTION
Fetch details of an access request by request ID
EXAMPLES
$ opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
$ opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4 --verbose
`
_See code: src/commands/request/get.ts_
Lists your n recent outgoing access requests
`
USAGE
$ opal request list [-h] [-n
FLAGS
-h, --help Show CLI help.
-n, --n=
-p, --pending Show only pending requests. Defaults to false.
-v, --verbose Enable verbose output, prints full response in JSON format. Defaults to false.
DESCRIPTION
Lists your n recent outgoing access requests
ALIASES
$ opal request ls
EXAMPLES
$ opal request list --n 5
$ opal request list --n 5 --pending
$ opal request list --n 5 --verbose
$ opal request list --n 5 --pending --verbose
`
_See code: src/commands/request/list.ts_
Lists your n recent outgoing access requests
`
USAGE
$ opal request ls [-h] [-n
FLAGS
-h, --help Show CLI help.
-n, --n=
-p, --pending Show only pending requests. Defaults to false.
-v, --verbose Enable verbose output, prints full response in JSON format. Defaults to false.
DESCRIPTION
Lists your n recent outgoing access requests
ALIASES
$ opal request ls
EXAMPLES
$ opal request list --n 5
$ opal request list --n 5 --pending
$ opal request list --n 5 --verbose
$ opal request list --n 5 --pending --verbose
`
Get resource info for a particular resource.
`
USAGE
$ opal resources get [-h] [-i
FLAGS
-h, --help Show CLI help.
-i, --id=
DESCRIPTION
Get resource info for a particular resource.
EXAMPLES
$ opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
`
_See code: src/commands/resources/get.ts_
Set authentication configuration values
`
USAGE
$ opal set-auth-config [--organizationID
FLAGS
--clientID=
--issuerUrl=
--organizationID=
DESCRIPTION
Set authentication configuration values
EXAMPLES
$ opal set-auth-config --clientID=abc123
$ opal set-auth-config --organizationID=org-456
$ opal set-auth-config --issuerUrl=https://auth.example.com
$ opal set-auth-config --clientID=abc123 --issuerUrl=https://auth.example.com
$ opal set-auth-config --organizationID=org-456 --clientID=abc123 --issuerUrl=https://auth.example.com
`
_See code: src/commands/set-auth-config.ts_
Sets a custom HTTP header to connect to the Opal server.
`
USAGE
$ opal set-custom-header [-h] [--header
FLAGS
-h, --help Show CLI help.
--header=
DESCRIPTION
Sets a custom HTTP header to connect to the Opal server.
EXAMPLES
$ opal set-custom-header --header 'cf-access-token: $TOKEN'
`
_See code: src/commands/set-custom-header.ts_
Sets an API token to authenticate with the Opal server - alternative auth flow for headless environments.
`
USAGE
$ opal set-token [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Sets an API token to authenticate with the Opal server - alternative auth flow for headless environments.
EXAMPLES
$ opal set-token
`
_See code: src/commands/set-token.ts_
Sets the url of the Opal server. Defaults to https://app.opal.dev.
`
USAGE
$ opal set-url [URL] [-h] [--allowSelfSignedCerts]
ARGUMENTS
URL URL of the Opal server to use. If unspecified, defaults to https://app.opal.dev
FLAGS
-h, --help Show CLI help.
--allowSelfSignedCerts
DESCRIPTION
Sets the url of the Opal server. Defaults to https://app.opal.dev.
EXAMPLES
$ opal set-url
`
_See code: src/commands/set-url.ts_
Use SCP to copy files from a compute instance.
`
USAGE
$ opal ssh copyFrom --src
FLAGS
-h, --help Show CLI help.
-i, --id=
--dest=
--src=
directory at a time.
--user=
to each other's home directory.
DESCRIPTION
Use SCP to copy files from a compute instance.
EXAMPLES
$ opal ssh:copyFrom --src instance/dir --dest my/dir
$ opal ssh:copyFrom --src instance/dir --dest my/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
`
_See code: src/commands/ssh/copyFrom.ts_
Use SCP to copy files to a compute instance.
`
USAGE
$ opal ssh copyTo --src
FLAGS
-h, --help Show CLI help.
-i, --id=
--dest=
--src=
directory at a time.
--user=
to each other's home directory.
DESCRIPTION
Use SCP to copy files to a compute instance.
EXAMPLES
$ opal ssh:copyTo --src my/dir --dest instance/dir
$ opal ssh:copyTo --src my/dir --dest instance/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
`
_See code: src/commands/ssh/copyTo.ts_
Starts an SSH session to access a compute instance.
`
USAGE
$ opal ssh start [-h] [-i
FLAGS
-h, --help Show CLI help.
-i, --id=
DESCRIPTION
Starts an SSH session to access a compute instance.
EXAMPLES
$ opal ssh:start
$ opal ssh:start --id 51f7176b-0464-4a6f-8369-e951e187b398
`
_See code: src/commands/ssh/start.ts_
`
USAGE
$ opal version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
`
_See code: @oclif/plugin-version_
Describes current url set, organization name, and logged in user if applicable.
`
USAGE
$ opal whoami [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Describes current url set, organization name, and logged in user if applicable.
``
_See code: src/commands/whoami.ts_