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 a sindri clone CLI command #95

Merged
merged 5 commits into from
Mar 21, 2024
Merged

Add a sindri clone CLI command #95

merged 5 commits into from
Mar 21, 2024

Conversation

sangaline
Copy link
Contributor

This adds a sindri clone command which can be used to download either your own circuit or somebody else's public circuit. You can either specify an exact circuit UUID or DockerHub inspired identifiers like <circuit-name>, <circuit-name>:<tag>, <team>/<circuit-name>, or <team>/<circuit-name>:<tag>.

Usage: sindri clone [options] <circuit> [directory]

Clone a circuit into a local directory.

Arguments:
circuit     The circuit to clone.
directory   The directory to clone the circuit into.

Options:
-h, --help  display help for command

I haven't added it to the SDK yet, we'll need to think about a good interface to simultaneously support browser and node there. The auto-generated internal API client unfortunately required a number of modifications in order to support streaming responses which are necessary for very large circuit packages. These are starting to build up, and we need to think about ways to generalize these diff patches as part of the generation process. The openapi-typescript-codegen codebase is unfortunately really complicated, so it's not practical to fork or patch it directly.

@@ -1,3 +1 @@
/targets/
Prover.toml
Verifier.toml
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Semi-unrelated, but I think these are actually useful to have in the package now that we have the clone capability.

Copy link

@jason-sindri jason-sindri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sangaline sangaline merged commit d6b6822 into main Mar 21, 2024
5 checks passed
@sangaline sangaline deleted the ews-add-clone-command branch March 21, 2024 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants