You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update installation guide and tutorial to recommend `proof_frog
download-examples` as the primary way to obtain examples, replacing
`git clone`. Add download-examples to the CLI reference with full
documentation of --ref and --force options.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: manual/cli-reference.md
+39-1Lines changed: 39 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ nav_order: 60
7
7
8
8
# CLI Reference
9
9
10
-
The ProofFrog command-line interface (`proof_frog`) lets you parse, type-check, and verify cryptographic game-hopping proofs entirely from the terminal. Six public commands cover the full workflow from inspecting files to running complete proof verification. If you prefer a graphical environment, a browser-based editor is also available via the `web` command described below.
10
+
The ProofFrog command-line interface (`proof_frog`) lets you parse, type-check, and verify cryptographic game-hopping proofs entirely from the terminal. Seven public commands cover the full workflow from inspecting files to running complete proof verification. If you prefer a graphical environment, a browser-based editor is also available via the `web` command described below.
11
11
12
12
> **Activate your Python virtual environment first.** All of the commands below assume that the virtual environment in which ProofFrog was installed is activated in the current terminal session. If you opened a new terminal, re-activate it before running any `proof_frog` (or `python -m proof_frog`) command:
13
13
>
@@ -27,6 +27,7 @@ The ProofFrog command-line interface (`proof_frog`) lets you parse, type-check,
27
27
|[`check`](#check)| Type-check and semantically analyze a FrogLang file. |
28
28
|[`prove`](#prove)| Run proof verification on a `.proof` file. |
29
29
|[`describe`](#describe)| Print a concise interface description of a FrogLang file. |
30
+
|[`download-examples`](#download-examples)| Download the examples repository. |
30
31
|[`web`](#web)| Start the ProofFrog web interface. |
Downloads the [ProofFrog examples repository](https://github.com/ProofFrog/examples) into the specified directory (default: `examples`). By default the command downloads the version of the examples that was pinned when your copy of ProofFrog was built, ensuring the examples are compatible with your installed version. Use `--ref` to override this and download a specific commit, tag, or branch instead. If the target directory already exists, the command exits with an error unless `--force` is passed.
237
+
238
+
### Options
239
+
240
+
| Flag | Description |
241
+
|------|-------------|
242
+
|`--force`| Overwrite the target directory if it already exists. |
243
+
|`--ref REF`| Git ref (commit SHA, tag, or branch) to download. Defaults to the version pinned at build time. |
244
+
245
+
### Examples
246
+
247
+
```bash
248
+
# Download the examples matching your version of ProofFrog into an "examples" directory
Copy file name to clipboardExpand all lines: manual/installation.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,16 +138,13 @@ Do not use `sudo pip install` to work around a `command not found` error. Instal
138
138
139
139
## Get the examples
140
140
141
-
ProofFrog has a companion repository of example proof files. To download it, run:
141
+
ProofFrog has a companion repository of example proof files. The easiest way to get them is with the built-in `download-examples` command:
142
142
143
143
```bash
144
-
git clone https://github.com/ProofFrog/examples
144
+
proof_frog download-examples
145
145
```
146
146
147
-
This creates an `examples/` directory in your current location containing primitives, schemes, games, and proofs from introductory cryptography.
148
-
149
-
{: .note }
150
-
If you do not have git installed, you can download the examples as a ZIP file from GitHub: go to [github.com/ProofFrog/examples](https://github.com/ProofFrog/examples), click the green **Code** button, and choose **Download ZIP**.
147
+
This creates an `examples/` directory in your current location containing primitives, schemes, games, and proofs from introductory cryptography. The command downloads the exact version of the examples that matches your installed ProofFrog release.
Copy file name to clipboardExpand all lines: manual/tutorial/hello-frog.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,16 +24,13 @@ Make sure you've [installed ProofFrog]({% link manual/installation.md %}).
24
24
25
25
## Get the examples
26
26
27
-
Clone the ProofFrog examples repository:
27
+
Download the ProofFrog examples:
28
28
29
29
```bash
30
-
git clone https://github.com/ProofFrog/examples
30
+
proof_frog download-examples
31
31
```
32
32
33
-
This creates an `examples/` directory containing primitives, schemes, games, and proofs from introductory cryptography. The rest of this tutorial assumes you cloned it in your current working directory, so that the path `examples/joy/` exists.
34
-
35
-
{: .note }
36
-
If you do not have git, you can download a zip file containing the examples from the **Code** button on the [examples GitHub page](https://github.com/ProofFrog/examples).
33
+
This creates an `examples/` directory containing primitives, schemes, games, and proofs from introductory cryptography. The rest of this tutorial assumes you ran this command in your current working directory, so that the path `examples/joy/` exists.
0 commit comments