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

History

122 lines (114 loc) · 3.1 KB

Raw

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 interactive login',

description: 'Install gh and log in via browser — no token needed. Use interactiveLogin: true as a shortcut instead of a separate github-cli-auth block.',

configs: [

{

type: 'github-cli',

gitProtocol: 'ssh',

interactiveLogin: true,

};

export const exampleGithubCliFull: ExampleConfig = {

title: 'GitHub CLI with token authentication',

description: 'Install gh, configure SSH as the default git protocol, and authenticate with a personal access token.',

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',

};

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

Uh oh!

Expand file tree

Breadcrumbs

examples.ts

Latest commit

History

Breadcrumbs

examples.ts

File metadata and controls