Skip to content

point to the new example CLI usage repo #438

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.

Sign up for GitHub

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

Merged
jakecoffman merged 1 commit into from
May 7, 2025
Merged

point to the new example CLI usage repo #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</picture>
</h1>

The `dependabot` CLI is a tool for testing and debugging Dependabot update jobs.
The `dependabot` CLI is a tool for running Dependabot update jobs.

## Installation

Expand Down Expand Up @@ -60,7 +60,8 @@ Use "dependabot [command] --help" for more information about a command.
### `dependabot update`

Run the `update` subcommand to run a Dependabot update job for the provided ecosystem and repo.
This does not create PRs, but outputs data that could be used to create PRs.
This does not create PRs, but outputs data that could be used to create PRs. For an example of how to do that see
the [example CLI usage](https://github.com/dependabot/example-cli-usage) repo.

```console
$ dependabot update go_modules dependabot/cli
Expand Down Expand Up @@ -149,9 +150,9 @@ with values from the environment.

> **Note**
>
> The job description file format isn't documented publicly,
> but you can find examples in the [`testdata` directory](testdata/)
> and check out [the `Job` class in `dependabot-core`][dependabot-updater-job].
> The job description file format isn't documented formally yet,
> but you can find examples in the [smoke tests](https://github.com/dependabot/smoke-tests/tree/main/tests)
> and look at the [model directory](/internal/model) for how the CLI models the job.

### How it works

Expand Down