chore: deprecate ssh commands

ionic-team · Dec 12, 2023 · ba98523 · ba98523
1 parent d09653d
commit ba98523
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 7 deletions.
diff --git a/packages/@ionic/cli/src/commands/ssh/add.ts b/packages/@ionic/cli/src/commands/ssh/add.ts
@@ -18,7 +18,7 @@ export class SSHAddCommand extends SSHBaseCommand implements CommandPreRun {
     return {
       name: 'add',
       type: 'global',
-      summary: 'Add an SSH public key to Ionic',
+      summary: 'Add an SSH public key to Ionic (Deprecated)',
       inputs: [
         {
           name: 'pubkey-path',

diff --git a/packages/@ionic/cli/src/commands/ssh/delete.ts b/packages/@ionic/cli/src/commands/ssh/delete.ts
@@ -10,7 +10,7 @@ export class SSHDeleteCommand extends SSHBaseCommand implements CommandPreRun {
     return {
       name: 'delete',
       type: 'global',
-      summary: 'Delete an SSH public key from Ionic',
+      summary: 'Delete an SSH public key from Ionic (Deprecated)',
       inputs: [
         {
           name: 'key-id',

diff --git a/packages/@ionic/cli/src/commands/ssh/generate.ts b/packages/@ionic/cli/src/commands/ssh/generate.ts
@@ -15,7 +15,7 @@ export class SSHGenerateCommand extends SSHBaseCommand implements CommandPreRun
     return {
       name: 'generate',
       type: 'global',
-      summary: 'Generates a private and public SSH key pair',
+      summary: 'Generates a private and public SSH key pair (Deprecated)',
       inputs: [
         {
           name: 'key-path',

diff --git a/packages/@ionic/cli/src/commands/ssh/index.ts b/packages/@ionic/cli/src/commands/ssh/index.ts
@@ -7,11 +7,13 @@ export class SSHNamespace extends Namespace {
 
     return {
       name: 'ssh',
-      summary: 'Commands for configuring SSH keys',
+      summary: 'Commands for configuring SSH keys (Deprecated)',
       description: `
 These commands help automate your SSH configuration for Ionic. As an alternative, SSH configuration can be done entirely manually by visiting your Personal Settings[^dashboard-settings-ssh-keys].
 
 To begin, run ${input('ionic ssh setup')}, which lets you use existing keys or generate new ones just for Ionic.
+
+Deprecated. Developers should configure SSH by visting their Personal Settings at https://dashboard.ionicframework.com/settings/ssh-keys.
       `,
       footnotes: [
         {

diff --git a/packages/@ionic/cli/src/commands/ssh/list.ts b/packages/@ionic/cli/src/commands/ssh/list.ts
@@ -11,7 +11,7 @@ export class SSHListCommand extends SSHBaseCommand implements CommandPreRun {
     return {
       name: 'list',
       type: 'global',
-      summary: 'List your SSH public keys on Ionic',
+      summary: 'List your SSH public keys on Ionic (Deprecated)',
       options: [
         {
           name: 'json',

diff --git a/packages/@ionic/cli/src/commands/ssh/setup.ts b/packages/@ionic/cli/src/commands/ssh/setup.ts
@@ -15,7 +15,7 @@ export class SSHSetupCommand extends SSHBaseCommand {
     return {
       name: 'setup',
       type: 'global',
-      summary: 'Setup your Ionic SSH keys automatically',
+      summary: 'Setup your Ionic SSH keys automatically (Deprecated)',
       description: `
 This command offers a setup wizard for Ionic SSH keys using a series of prompts. For more control, see the commands available for managing SSH keys with the ${input('ionic ssh --help')} command. For an entirely manual approach, see ${strong('Personal Settings')} => ${strong('SSH Keys')} in the Dashboard[^dashboard-settings-ssh-keys].
 

diff --git a/packages/@ionic/cli/src/commands/ssh/use.ts b/packages/@ionic/cli/src/commands/ssh/use.ts
@@ -13,7 +13,7 @@ export class SSHUseCommand extends SSHBaseCommand {
     return {
       name: 'use',
       type: 'global',
-      summary: 'Set your active Ionic SSH key',
+      summary: 'Set your active Ionic SSH key (Deprecated)',
       description: `
 This command modifies the SSH configuration file (${strong('~/.ssh/config')}) to set an active private key for the ${strong('git.ionicjs.com')} host. Read more about SSH configuration by running the ${input('man ssh_config')} command or by visiting online man pages[^ssh-config-docs].