Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 5.42 KB

KHCommand.md

File metadata and controls

107 lines (71 loc) · 5.42 KB

Command Tool Functions

###help: help command to list all functions KHCommand <sub_command> <args1..N>

###addAgent: adds agent specified in <agent.json> from KH Server at KHCommand addAgent <agent.json>

###deleteAgent: deletes agent specified in <agent.json> from KH Server at KHCommand deleteAgent <agent.json>

###resetAgent: stops/restarts an agent specified in <agent.json> from KH Server at KHCommand restAgent <agent.json>

###updateAgent: updates agent specified in <agent.json> from KH Server at KHCommand updateAgent <agent.json>

###getAgentInfo: updates agent specified in <agent.json> from KH Server at KHCommand getAgentInfo <agent.json>

###listAgents: lists all agents on a KH server specified bu KHCommand listAgents

###getAgentLogs: gets agent logs specified in <agent.json> from KH Server at KHCommand getAgentLogs <agent.json>

###listRepositories: lists repositories on the knowhow server at KHCommand listRepositories

###addRepo: adds a repository specifified in <repo.json> on the knowhow server at KHCommand addRepo <repo.json>

###updateRepo: updates repository specifified in <repo.json> on the knowhow server at KHCommand updateRepo <repo.json>

###deleteRepo: deletes a repository specifified in <repo.json> on the knowhow server at KHCommand deleteRepo <repo.json>

###loadRepo: loads a repository specifified in <repo.json> on the knowhow server at KHCommand loadRepo <repo.json>

###loadRepoFromName: loads a repository based on repoName specifified in <repo.json> on the knowhow server at KHCommand loadRepoFromName <repo.json>

###loadFile: loads fileContent as a string on the knowhow server at KHCommand loadFile

###addFile: adds a file with content to location on the knowhow server at KHCommand addFile

###deleteFile: deletes a file at repository location on the knowhow server at KHCommand addFile

###saveFile: saves a file with content at repository location on the knowhow server at KHCommand saveFile

###loadURL: returns the content of any text file based on a knowhow url KHCommand saveFile

###importFileRepositoryFromGit: imports a knowhow repository into a server based on a git URL KHCommand importFileRepositoryFromGit

###importFileRepositoryFromServer: imports a knowhow repository into a server based on a git URL KHCommand importFileRepositoryFromServer

###importFileRepositoryFromTarBall: imports a knowhow repository into a server from a .tar.gz archive KHCommand importFileRepositoryFromTarBall

###downloadRepoAsTarBall: downloads a knowhow repository from a server and saves to path as .tar.gz archive KHCommand downloadRepoAsTarBall

###executeJob: executes a job on a specified agent <Agent.json> through on the knowhow server at KHCommand executeJob <agent.json> <job.json >

###cancelJob: cancels a job on a specified agent <Agent.json> through on the knowhow server at KHCommand cancelJob <agent.json> <job.json>

###getRunningJobsList: gets a running list of jobs on the knowhow server at KHCommand getRunningJobsList

###loadAgentsForEnvironment: ensures all agents for environment are running on the knowhow server at KHCommand loadAgentsForEnvironment <environment.json>

###connectEnvironmentAgents: ensures all agents for environment are running on the knowhow server at KHCommand connectEnvironmentAgents <environment.json>

###executeWorkflow: executes a workflow against an environment on the knowhow server at KHCommand executeWorkflow <environment.json>, <workflow.json>

###cancelWorkflow: cancels the specified workflow running against environment on the knowhow server at KHCommand ecancelWorkflow <environment.json>, <workflow.json>

###getRunningWorksList: gets a running list of workflows on the knowhow server at KHCommand getRunningWorkflowsList

###agentHeartbeat: checks if agent specified in <agent.json> can be reached from KH Server at KHCommand agentHeartbeat <agent.json>

###waitForAgentStartup: waits for agent specified in <agent.json> onKH Server at to start. Useful script flow control. KHCommand waitForAgentStartup <agent.json>

###serverHeartbeat: checks if KH Server at is alive KHCommand serverHeartbeat

###waitForServerStartup: waits until registers a heartbeat KHCommand waitForServerStartup