@civic/solana-gatekeeper-cli
v0.0.2
Published
CLI to manage Gateway Tokens
Downloads
5
Maintainers
Keywords
Readme
gatekeeper-cli
CLI to manage OCIV Gateway Tokens
Usage
$ npm install -g @civic/solana-gatekeeper-cli
$ gateway COMMAND
running command...
$ gateway (-v|--version|version)
@civic/solana-gatekeeper-cli/0.0.2 darwin-arm64 node-v20.13.1
$ gateway --help [COMMAND]
USAGE
$ gateway COMMAND
...
Commands
gateway add-gatekeeper ADDRESS
gateway burn GATEWAYTOKEN
gateway freeze GATEWAYTOKEN
gateway help [COMMAND]
gateway issue ADDRESS
gateway network-feature FEATURE
gateway plugins
gateway plugins:inspect PLUGIN...
gateway plugins:install PLUGIN...
gateway plugins:link PLUGIN
gateway plugins:uninstall PLUGIN...
gateway plugins:update
gateway refresh GATEWAYTOKEN [EXPIRY]
gateway revoke GATEWAYTOKEN
gateway revoke-gatekeeper ADDRESS
gateway unfreeze GATEWAYTOKEN
gateway verify OWNER
gateway version
gateway add-gatekeeper ADDRESS
Add a gatekeeper to a network
USAGE
$ gateway add-gatekeeper ADDRESS
ARGUMENTS
ADDRESS The address of the gatekeeper to add to the network
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The private key file for the
gatekeeper authority
--skipPreflight Skip preflight check
EXAMPLE
$ gateway add-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp
gateway burn GATEWAYTOKEN
Burns a gateway token
USAGE
$ gateway burn GATEWAYTOKEN
ARGUMENTS
GATEWAYTOKEN The gateway token to burn
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway burn EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
Burned
gateway freeze GATEWAYTOKEN
Freeze a gateway token
USAGE
$ gateway freeze GATEWAYTOKEN
ARGUMENTS
GATEWAYTOKEN The gateway token to freeze
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway freeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
Frozen
gateway help [COMMAND]
Display help for gateway.
USAGE
$ gateway help [COMMAND]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
-n, --nested-commands Include all nested commands in the output.
See code: @oclif/plugin-help
gateway issue ADDRESS
Issue a gateway token to a wallet
USAGE
$ gateway issue ADDRESS
ARGUMENTS
ADDRESS The address to issue the token to
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-e, --expiry=expiry The expiry time in seconds for the gateway token (default
none)
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway issue EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv2QJjjrzdPSrcZUuAH2KrEU61crWz49KnSLSzwjDUnLSV
gateway network-feature FEATURE
Get or Change a Network Feature
USAGE
$ gateway network-feature FEATURE
ARGUMENTS
FEATURE The Network Feature Name
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The private key file for the
gatekeeper authority
-o, --featureOperation=add|remove|get [default: get] add, remove, or get a network feature
--skipPreflight Skip preflight check
EXAMPLE
$ gateway network-feature userTokenExpiry
gateway plugins
List installed plugins.
USAGE
$ gateway plugins
OPTIONS
--core Show core plugins.
EXAMPLE
$ gateway plugins
See code: @oclif/plugin-plugins
gateway plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ gateway plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
OPTIONS
-h, --help Show CLI help.
-v, --verbose
EXAMPLE
$ gateway plugins:inspect myplugin
See code: @oclif/plugin-plugins
gateway plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ gateway plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
OPTIONS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ gateway plugins:add
EXAMPLES
$ gateway plugins:install myplugin
$ gateway plugins:install https://github.com/someuser/someplugin
$ gateway plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
gateway plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ gateway plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ gateway plugins:link myplugin
See code: @oclif/plugin-plugins
gateway plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ gateway plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help Show CLI help.
-v, --verbose
ALIASES
$ gateway plugins:unlink
$ gateway plugins:remove
See code: @oclif/plugin-plugins
gateway plugins:update
Update installed plugins.
USAGE
$ gateway plugins:update
OPTIONS
-h, --help Show CLI help.
-v, --verbose
See code: @oclif/plugin-plugins
gateway refresh GATEWAYTOKEN [EXPIRY]
Refresh a gateway token
USAGE
$ gateway refresh GATEWAYTOKEN [EXPIRY]
ARGUMENTS
GATEWAYTOKEN The gateway token to freeze
EXPIRY [default: 54000] The new expiry time in seconds for the gateway token (default 15 minutes)
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway refresh EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv 54000
Refreshed
gateway revoke GATEWAYTOKEN
Revoke a gateway token
USAGE
$ gateway revoke GATEWAYTOKEN
ARGUMENTS
GATEWAYTOKEN The gateway token to revoke
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway revoke EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
Revoked
gateway revoke-gatekeeper ADDRESS
Revoke a gatekeeper from a network
USAGE
$ gateway revoke-gatekeeper ADDRESS
ARGUMENTS
ADDRESS The address of the gatekeeper to revoke from the network
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The private key file for the
gatekeeper authority
--skipPreflight Skip preflight check
EXAMPLE
$ gateway revoke-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp
gateway unfreeze GATEWAYTOKEN
Unfreeze a gateway token
USAGE
$ gateway unfreeze GATEWAYTOKEN
ARGUMENTS
GATEWAYTOKEN The gateway token to unfreeze
OPTIONS
-a, --airdrop Airdrop SOL if needed
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-f, --priorityFeeLamports=priorityFeeLamports [default: 0] The priority fee in lamports
-g, --gatekeeperKey=gatekeeperKey [default: [object Object]] The private key file for the
gatekeeper authority
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
--skipPreflight Skip preflight check
EXAMPLE
$ gateway unfreeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
Unfrozen
gateway verify OWNER
Verify a gateway token
USAGE
$ gateway verify OWNER
ARGUMENTS
OWNER The gateway token to revoke
OPTIONS
-c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet [default: mainnet-beta] The cluster to target.
Alternatively, set the environment variable
SOLANA_CLUSTER. To override this property with a specific
endpoint url, set SOLANA_CLUSTER_URL
-h, --help Show CLI help.
-n, --gatekeeperNetworkKey=gatekeeperNetworkKey [default: [object Object]] The public key (in base 58) of
the gatekeeper network that the gatekeeper belongs to.
EXAMPLE
$ gateway verify EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
{
"issuingGatekeeper": "tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp",
"gatekeeperNetwork": "48V9nmW9awiR9BmihdGhUL3ZpYJ8MCgGeUoSWbtqjicv",
"owner": "EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv",
"state": "ACTIVE",
"publicKey": "3rNZ6RzH6jLCzFeySVDc8Z82sJkeQ4xi7BCUzjpZBvZr",
"programId": "gatem74V238djXdzWnJf94Wo1DcnuGkfijbf3AuBhfs"
}
gateway version
USAGE
$ gateway version
OPTIONS
--json Format output as json.
--verbose Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI
is using.
See code: @oclif/plugin-version
Note - if you are looking for the CLI tool, it has been moved to @civic/solana-gatekeeper-cli