Skip to content

replace --json with --format json #198

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

Open
davidpdrsn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

replace --json with --format json #198

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions content/docs/cli-guides/cli-tutorial/scripting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ title: Scripting
description: How to script with GitButler CLI
---

### JSON Errwhere
### JSON output

All of the commands are designed to be very user friendly when we have an interactive terminal, but you can also very easily script everything by passing the `--json` or `-j` option to anything. For example, here is using `but show` on a commit.
Commands are designed to be user friendly in an interactive terminal, and you can script them by passing `--format json` to commands that support JSON output. For example, here is `but show` on a commit.

```cli [scripting-but-show-1, 308px]
but show 2672465
```

Now with the `--json` option:
Now with JSON output:

```cli [scripting-but-show-2, 682px]
but show --json 2672465 | jq
but show --format json 2672465 | jq
```

You can do this with anything - committing, status, diffing, etc. Just throw a `-j` in there and you get parseable data (or, data your agent can very easily work with).
You can use `--format json` with commands that support formatted output, such as committing, status, and diffing, to get parseable data for scripts or agents.
2 changes: 1 addition & 1 deletion public/cache/cli-output/scripting-but-show-2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="UTF-8">
<title>/usr/local/bin/but show --json 2672465 | jq</title>
<title>/usr/local/bin/but show --format json 2672465 | jq</title>
<style>
body {
background-color: #ffffff;
Expand Down
10 changes: 5 additions & 5 deletions public/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5185,21 +5185,21 @@ Now you can copy that SHA and restore to that exact point at any time in the fut

# scripting.mdx

### JSON Errwhere
### JSON output

All of the commands are designed to be very user friendly when we have an interactive terminal, but you can also very easily script everything by passing the `--json` or `-j` option to anything. For example, here is using `but show` on a commit.
Commands are designed to be user friendly in an interactive terminal, and you can script them by passing `--format json` to commands that support JSON output. For example, here is `but show` on a commit.

```cli [scripting-but-show-1, 308px]
but show 2672465
```

Now with the `--json` option:
Now with JSON output:

```cli [scripting-but-show-2, 682px]
but show --json 2672465 | jq
but show --format json 2672465 | jq
```

You can do this with anything - committing, status, diffing, etc. Just throw a `-j` in there and you get parseable data (or, data your agent can very easily work with).
You can use `--format json` with commands that support formatted output, such as committing, status, and diffing, to get parseable data for scripts or agents.


# tutorial-overview.mdx
Expand Down