default-plugin/src/resources/github-cli/examples.ts at 8d9ba66233ed0549d87713e20c687e6fc2276962 · codifycli/default-plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
import { ExampleConfig } from '@codifycli/plugin-core';

export const exampleGithubCliBasic: ExampleConfig = {
  title: 'Install GitHub CLI with SSH configuration',
  description: 'Install gh and configure it to use SSH for git operations and vim as the default editor.',
  configs: [
    {
      type: 'github-cli',
      gitProtocol: 'ssh',
      editor: 'vim',
    },
  ],
};

export const exampleGithubCliFull: ExampleConfig = {
  title: 'Full GitHub CLI setup with authentication',
  description: 'Install gh, authenticate with a personal access token, and configure SSH as the default git protocol.',
  configs: [
    {
      type: 'github-cli',
      gitProtocol: 'ssh',
    },
    {
      type: 'github-cli-auth',
      token: '<Replace me here!>',
    },
  ],
};

export const exampleGithubCliAuthBasic: ExampleConfig = {
  title: 'Authenticate GitHub CLI with a token',
  description: 'Log in to GitHub using a personal access token for non-interactive environments.',
  configs: [
    {
      type: 'github-cli-auth',
      token: '<Replace me here!>',
    },
  ],
};

export const exampleGithubCliAuthEnterprise: ExampleConfig = {
  title: 'Authenticate to GitHub Enterprise',
  description: 'Log in to a self-hosted GitHub Enterprise Server instance with a PAT.',
  configs: [
    {
      type: 'github-cli',
    },
    {
      type: 'github-cli-auth',
      token: '<Replace me here!>',
      hostname: 'github.mycompany.com',
    },
  ],
};

export const exampleGithubCliAliasBasic: ExampleConfig = {
  title: 'Add a gh CLI alias',
  description: 'Create a short alias "prc" that expands to "pr create" for faster pull request creation.',
  configs: [
    {
      type: 'github-cli-alias',
      alias: 'prc',
      expansion: 'pr create',
    },
  ],
};

export const exampleGithubCliAliasShell: ExampleConfig = {
  title: 'Full GitHub CLI setup with aliases',
  description: 'Install gh, authenticate, and set up handy aliases for common workflows.',
  configs: [
    {
      type: 'github-cli',
    },
    {
      type: 'github-cli-auth',
      token: '<Replace me here!>',
    },
    {
      type: 'github-cli-alias',
      alias: 'prc',
      expansion: 'pr create',
    },
    {
      type: 'github-cli-alias',
      alias: 'prs',
      expansion: 'pr status',
    },
  ],
};

export const exampleGithubCliSshKeyBasic: ExampleConfig = {
  title: 'Upload SSH key to GitHub',
  description: 'Register an existing local SSH public key with your GitHub account for authentication.',
  configs: [
    {
      type: 'github-cli-ssh-key',
      title: 'My Laptop',
      keyFile: '~/.ssh/id_ed25519.pub',
    },
  ],
};

export const exampleGithubCliSshKeyFull: ExampleConfig = {
  title: 'Full SSH key setup for GitHub',
  description: 'Install gh, authenticate, then upload a local SSH key to your GitHub account.',
  configs: [
    {
      type: 'github-cli',
    },
    {
      type: 'github-cli-auth',
      token: '<Replace me here!>',
    },
    {
      type: 'github-cli-ssh-key',
      title: 'My Laptop',
      keyFile: '~/.ssh/id_ed25519.pub',
      keyType: 'authentication',
    },
  ],
};