SSH keys
SSH keys used to reach servers and clone private repositories. Generated from the `notploy` command surface.
SSH keys used to reach servers and clone private repositories.
notploy ssh-key exposes 7 commands. They map one-to-one onto the ssh-key.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy ssh-key --help to list these commands in your terminal, or
notploy ssh-key <command> --help for a single command.
Commands
notploy ssh-key all
Calls GET /api/trpc/sshKey.all.
notploy ssh-key all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy ssh-key all-for-apps
Calls GET /api/trpc/sshKey.allForApps.
notploy ssh-key all-for-apps [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy ssh-key create
Calls POST /api/trpc/sshKey.create.
notploy ssh-key create --name <value> --privateKey <value> --publicKey <value> --organizationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--description <value> | string | No | — |
--privateKey <value> | string | Yes | — |
--publicKey <value> | string | Yes | — |
--organizationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy ssh-key generate
Calls POST /api/trpc/sshKey.generate.
notploy ssh-key generate [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--type <value> | string | No | rsa, ed25519 |
--profile <name> | string | No | — |
notploy ssh-key one
Calls GET /api/trpc/sshKey.one.
notploy ssh-key one --sshKeyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--sshKeyId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy ssh-key remove
Calls POST /api/trpc/sshKey.remove.
notploy ssh-key remove --sshKeyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--sshKeyId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy ssh-key update
Calls POST /api/trpc/sshKey.update.
notploy ssh-key update --sshKeyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | No | — |
--description <value> | string | No | — |
--lastUsedAt <value> | string | No | — |
--sshKeyId <value> | string | Yes | — |
--profile <name> | string | No | — |