Skip to content
GitLab
Menu
Why GitLab
Pricing
Contact Sales
Explore
Why GitLab
Pricing
Contact Sales
Explore
Sign in
Get free trial
Primary navigation
Search or go to…
Project
buildgrid
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Privacy statement
Keyboard shortcuts
?
What's new
6
Snippets
Groups
Projects
Show more breadcrumbs
BuildGrid
buildgrid
Commits
179aecaf
Commit
179aecaf
authored
6 years ago
by
Martin Blanchard
Browse files
Options
Downloads
Patches
Plain Diff
docs: Update and fix CLI reference documentation
parent
27f39c94
No related branches found
No related tags found
Loading
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/reference_cli.rst
+31
-25
31 additions, 25 deletions
docs/source/reference_cli.rst
with
31 additions
and
25 deletions
docs/source/reference_cli.rst
+
31
−
25
View file @
179aecaf
.. _cli
_
reference:
.. _cli
-
reference:
CLI reference
CLI reference
=============
=============
...
@@ -8,112 +8,118 @@ BuildGrid's Command Line Interface (CLI) reference documentation.
...
@@ -8,112 +8,118 @@ BuildGrid's Command Line Interface (CLI) reference documentation.
----
----
.. _invoking
_
bgd:
.. _invoking
-
bgd:
.. click:: buildgrid._app:cli
.. click:: buildgrid._app:cli
:prog: bgd
:prog: bgd
----
----
.. _invoking
_
bgd
_
bot:
.. _invoking
-
bgd
-
bot:
.. click:: buildgrid._app.commands.cmd_bot:cli
.. click:: buildgrid._app.commands.cmd_bot:cli
:prog: bgd bot
:prog: bgd bot
----
----
.. _invoking
_
bgd
_
bot
_
buildbox:
.. _invoking
-
bgd
-
bot
-
buildbox:
.. click:: buildgrid._app.commands.cmd_bot:run_buildbox
.. click:: buildgrid._app.commands.cmd_bot:run_buildbox
:prog: bgd bot buildbot
:prog: bgd bot buildbot
----
----
.. _invoking
_
bgd
_
bot
_
dummy:
.. _invoking
-
bgd
-
bot
-
dummy:
.. click:: buildgrid._app.commands.cmd_bot:run_dummy
.. click:: buildgrid._app.commands.cmd_bot:run_dummy
:prog: bgd bot dummy
:prog: bgd bot dummy
----
----
.. _invoking
_
bgd
_
bot
_
temp
_
directory:
.. _invoking
-
bgd
-
bot
-
temp
-
directory:
.. click:: buildgrid._app.commands.cmd_bot:run_temp_directory
.. click:: buildgrid._app.commands.cmd_bot:run_temp_directory
:prog: bgd bot temp-directory
:prog: bgd bot temp-directory
----
----
.. _invoking
_
bgd
_
cas:
.. _invoking
-
bgd
-
cas:
.. click:: buildgrid._app.commands.cmd_cas:cli
.. click:: buildgrid._app.commands.cmd_cas:cli
:prog: bgd cas
:prog: bgd cas
----
----
.. _invoking
_
bgd
_
cas
_
upload
_
dir:
.. _invoking
-
bgd
-
cas
-
upload
-
dir:
.. click:: buildgrid._app.commands.cmd_cas:upload_dir
.. click:: buildgrid._app.commands.cmd_cas:upload_dir
:prog: bgd cas upload-dir
:prog: bgd cas upload-dir
----
----
.. _invoking
_
bgd
_
cas
_
upload
_
files:
.. _invoking
-
bgd
-
cas
-
upload
-
files:
.. click:: buildgrid._app.commands.cmd_cas:upload_files
.. click:: buildgrid._app.commands.cmd_cas:upload_files
:prog: bgd cas upload-files
:prog: bgd cas upload-files
----
----
.. _invoking
_
bgd
_
execute:
.. _invoking
-
bgd
-
execute:
.. click:: buildgrid._app.commands.cmd_execute:cli
.. click:: buildgrid._app.commands.cmd_execute:cli
:prog: bgd execute
:prog: bgd execute
----
----
.. _invoking
_
bgd
_
execute
_
command:
.. _invoking
-
bgd
-
execute
-
command:
.. click:: buildgrid._app.commands.cmd_execute:command
.. click:: buildgrid._app.commands.cmd_execute:command
:prog: bgd execute command
:prog: bgd execute command
----
----
.. _invoking
_
bgd
_
execute
_list
:
.. _invoking
-
bgd
-
execute
-request-dummy
:
.. click:: buildgrid._app.commands.cmd_execute:
list_operations
.. click:: buildgrid._app.commands.cmd_execute:
request_dummy
:prog: bgd execute
list
:prog: bgd execute
request-dummy
----
----
.. _invoking
_
bgd
_execute_ request_dummy
:
.. _invoking
-
bgd
-operation
:
.. click:: buildgrid._app.commands.cmd_
execute:request_dummy
.. click:: buildgrid._app.commands.cmd_
operation:cli
:prog: bgd
execute request-dummy
:prog: bgd
operation
----
----
.. _invoking
_
bgd
_execute_status
:
.. _invoking
-
bgd
-operation-list
:
.. click:: buildgrid._app.commands.cmd_
execute:
operation
_statu
s
.. click:: buildgrid._app.commands.cmd_operation
:list
s
:prog: bgd
execute status
:prog: bgd
operation list
----
----
.. _invoking
_
bgd
_execute_wait
:
.. _invoking
-
bgd
-operation-status
:
.. click:: buildgrid._app.commands.cmd_
execute:wait_execution
.. click:: buildgrid._app.commands.cmd_
operation:status
:prog: bgd
execute wait
:prog: bgd
operation status
----
----
.. _invoking_bgd_server:
.. _invoking-bgd-operation-wait:
.. click:: buildgrid._app.commands.cmd_operation:wait
:prog: bgd operation wait
----
.. _invoking-bgd-server:
.. click:: buildgrid._app.commands.cmd_server:cli
.. click:: buildgrid._app.commands.cmd_server:cli
:prog: bgd server
:prog: bgd server
----
----
.. _invoking
_
bgd
_
server
_
start:
.. _invoking
-
bgd
-
server
-
start:
.. click:: buildgrid._app.commands.cmd_server:start
.. click:: buildgrid._app.commands.cmd_server:start
:prog: bgd server start
:prog: bgd server start
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment