Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ToC to using_garm.md #229

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions doc/using_garm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,30 @@ This document will walk you through the various commands and options available i

While using the GARM cli, you will most likely spend most of your time listing pools and runners, but we will cover most of the available commands and options. Some of them we'll skip (like the `init` or `profile` subcommands), as they've been covered in the [quickstart](/doc/quickstart.md) document.

## Table of contents

<!-- TOC -->

- [Using GARM](#using-garm)
- [Listing controller info](#listing-controller-info)
- [Listing configured providers](#listing-configured-providers)
- [Listing github credentials](#listing-github-credentials)
- [Adding a new repository](#adding-a-new-repository)
- [Managing repository webhooks](#managing-repository-webhooks)
- [Listing repositories](#listing-repositories)
- [Removing a repository](#removing-a-repository)
- [Adding a new organization](#adding-a-new-organization)
- [Adding an enterprise](#adding-an-enterprise)
- [Creating a runner pool](#creating-a-runner-pool)
- [Listing pools](#listing-pools)
- [Showing pool info](#showing-pool-info)
- [Deleting a pool](#deleting-a-pool)
- [Update a pool](#update-a-pool)
- [Listing runners](#listing-runners)
- [Showing runner info](#showing-runner-info)
- [Deleting a runner](#deleting-a-runner)
- [The debug-log command](#the-debug-log-command)
- [Listing recorded jobs](#listing-recorded-jobs)

<!-- /TOC -->

## Listing controller info

Expand Down
Loading