github.com/pf-qiu/concourse/v6@v6.7.3-0.20201207032516-1f455d73275f/fly/commands/fly.go (about)

     1  package commands
     2  
     3  import (
     4  	"github.com/pf-qiu/concourse/v6/fly/rc"
     5  )
     6  
     7  type FlyCommand struct {
     8  	Help HelpCommand `command:"help" description:"Print this help message"`
     9  
    10  	Target       rc.TargetName       `short:"t" long:"target" description:"Concourse target name"`
    11  	Targets      TargetsCommand      `command:"targets" alias:"ts" description:"List saved targets"`
    12  	DeleteTarget DeleteTargetCommand `command:"delete-target" alias:"dtg" description:"Delete target"`
    13  	EditTarget   EditTargetCommand   `command:"edit-target" alias:"etg" description:"Edit a target"`
    14  
    15  	Version func() `short:"v" long:"version" description:"Print the version of Fly and exit"`
    16  
    17  	Verbose bool `long:"verbose" description:"Print API requests and responses"`
    18  
    19  	PrintTableHeaders bool `long:"print-table-headers" description:"Print table headers even for redirected output"`
    20  
    21  	Login  LoginCommand  `command:"login" alias:"l" description:"Authenticate with the target"`
    22  	Logout LogoutCommand `command:"logout" alias:"o" description:"Release authentication with the target"`
    23  	Status StatusCommand `command:"status" description:"Login status"`
    24  	Sync   SyncCommand   `command:"sync"  alias:"s" description:"Download and replace the current fly from the target"`
    25  
    26  	ActiveUsers ActiveUsersCommand `command:"active-users" alias:"au" description:"List the active users since a date or for the past 2 months"`
    27  	Userinfo    UserinfoCommand    `command:"userinfo" description:"User information"`
    28  
    29  	Teams       TeamsCommand       `command:"teams" alias:"t" description:"List the configured teams"`
    30  	GetTeam     GetTeamCommand     `command:"get-team"  alias:"gt" description:"Show team configuration"`
    31  	SetTeam     SetTeamCommand     `command:"set-team"  alias:"st" description:"Create or modify a team to have the given credentials"`
    32  	RenameTeam  RenameTeamCommand  `command:"rename-team"   alias:"rt" description:"Rename a team"`
    33  	DestroyTeam DestroyTeamCommand `command:"destroy-team"  alias:"dt" description:"Destroy a team and delete all of its data"`
    34  
    35  	Checklist ChecklistCommand `command:"checklist" alias:"cl" description:"Print a Checkfile of the given pipeline"`
    36  
    37  	Execute ExecuteCommand `command:"execute" alias:"e" description:"Execute a one-off build using local bits"`
    38  	Watch   WatchCommand   `command:"watch"   alias:"w" description:"Stream a build's output"`
    39  
    40  	Containers ContainersCommand `command:"containers" alias:"cs" description:"Print the active containers"`
    41  	Hijack     HijackCommand     `command:"hijack"     alias:"intercept" alias:"i" description:"Execute a command in a container"`
    42  
    43  	Jobs        JobsCommand        `command:"jobs"      alias:"js" description:"List the jobs in the pipelines"`
    44  	PauseJob    PauseJobCommand    `command:"pause-job" alias:"pj" description:"Pause a job"`
    45  	UnpauseJob  UnpauseJobCommand  `command:"unpause-job" alias:"uj" description:"Unpause a job"`
    46  	ScheduleJob ScheduleJobCommand `command:"schedule-job" alias:"sj" description:"Request the scheduler to run for a job. Introduced as a recovery command for the v6.0 scheduler."`
    47  
    48  	Pipelines        PipelinesCommand        `command:"pipelines"           alias:"ps"   description:"List the configured pipelines"`
    49  	DestroyPipeline  DestroyPipelineCommand  `command:"destroy-pipeline"    alias:"dp"   description:"Destroy a pipeline"`
    50  	GetPipeline      GetPipelineCommand      `command:"get-pipeline"        alias:"gp"   description:"Get a pipeline's current configuration"`
    51  	SetPipeline      SetPipelineCommand      `command:"set-pipeline"        alias:"sp"   description:"Create or update a pipeline's configuration"`
    52  	PausePipeline    PausePipelineCommand    `command:"pause-pipeline"      alias:"pp"   description:"Pause a pipeline"`
    53  	ArchivePipeline  ArchivePipelineCommand  `command:"archive-pipeline"    alias:"ap"   description:"Archive a pipeline"`
    54  	UnpausePipeline  UnpausePipelineCommand  `command:"unpause-pipeline"    alias:"up"   description:"Un-pause a pipeline"`
    55  	ExposePipeline   ExposePipelineCommand   `command:"expose-pipeline"     alias:"ep"   description:"Make a pipeline publicly viewable"`
    56  	HidePipeline     HidePipelineCommand     `command:"hide-pipeline"       alias:"hp"   description:"Hide a pipeline from the public"`
    57  	RenamePipeline   RenamePipelineCommand   `command:"rename-pipeline"     alias:"rp"   description:"Rename a pipeline"`
    58  	ValidatePipeline ValidatePipelineCommand `command:"validate-pipeline"   alias:"vp"   description:"Validate a pipeline config"`
    59  	FormatPipeline   FormatPipelineCommand   `command:"format-pipeline"     alias:"fp"   description:"Format a pipeline config"`
    60  	OrderPipelines   OrderPipelinesCommand   `command:"order-pipelines"     alias:"op"   description:"Orders pipelines"`
    61  
    62  	Resources              ResourcesCommand              `command:"resources"                  alias:"rs"   description:"List the resources in the pipeline"`
    63  	ResourceVersions       ResourceVersionsCommand       `command:"resource-versions"          alias:"rvs"  description:"List the versions of a resource"`
    64  	CheckResource          CheckResourceCommand          `command:"check-resource"             alias:"cr"   description:"Check a resource"`
    65  	PinResource            PinResourceCommand            `command:"pin-resource"               alias:"pr"   description:"Pin a version to a resource"`
    66  	UnpinResource          UnpinResourceCommand          `command:"unpin-resource"             alias:"ur"   description:"Unpin a resource"`
    67  	EnableResourceVersion  EnableResourceVersionCommand  `command:"enable-resource-version"    alias:"erv"  description:"Enable a version of a resource"`
    68  	DisableResourceVersion DisableResourceVersionCommand `command:"disable-resource-version"   alias:"drv"  description:"Disable a version of a resource"`
    69  
    70  	CheckResourceType CheckResourceTypeCommand `command:"check-resource-type" alias:"crt"  description:"Check a resource-type"`
    71  
    72  	ClearTaskCache ClearTaskCacheCommand `command:"clear-task-cache" alias:"ctc" description:"Clears cache from a task container"`
    73  
    74  	Builds     BuildsCommand     `command:"builds"      alias:"bs" description:"List builds data"`
    75  	AbortBuild AbortBuildCommand `command:"abort-build" alias:"ab" description:"Abort a build"`
    76  	RerunBuild RerunBuildCommand `command:"rerun-build" alias:"rb" description:"Rerun a build"`
    77  
    78  	TriggerJob TriggerJobCommand `command:"trigger-job" alias:"tj" description:"Start a job in a pipeline"`
    79  
    80  	Volumes VolumesCommand `command:"volumes" alias:"vs" description:"List the active volumes"`
    81  
    82  	Workers     WorkersCommand     `command:"workers" alias:"ws" description:"List the registered workers"`
    83  	LandWorker  LandWorkerCommand  `command:"land-worker" alias:"lw" description:"Land a worker"`
    84  	PruneWorker PruneWorkerCommand `command:"prune-worker" alias:"pw" description:"Prune a stalled, landing, landed, or retiring worker"`
    85  
    86  	Curl CurlCommand `command:"curl" alias:"c" description:"curl the api"`
    87  
    88  	Completion CompletionCommand `command:"completion" description:"generate shell completion code"`
    89  }
    90  
    91  var Fly FlyCommand