Skip to content

Commit

Permalink
GITBOOK-13: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
raphkhan authored and gitbook-bot committed May 24, 2024
1 parent 505bdeb commit 90d98d7
Show file tree
Hide file tree
Showing 44 changed files with 1 addition and 5,663 deletions.
42 changes: 1 addition & 41 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,3 @@
---
description: Giza CLI 0.17.0
---

# Giza CLI

Welcome to Giza CLI!

This CLI provides the utilities to interact with Giza using the terminal.

## 🤔 What capabilities does the CLI offer?

The CLI will serve as the main entrypoint for Giza Platform for developers. It aims to provide a tool to ease the managing of resources that exists in Giza Platform.

For now it provides the following capabilities:

* User related utilities, like `create`, `login` (JWT Authentication) and `create_api_key` (API Key Authentication)
* Model transpilation with `transpile` using multiple frameworks, like Cairo or EZKL
* Model versioning
* Proof generation for multiple frameworks, like Orion Cairo or EZKL
* Deployment of models to the Giza Platform as an endpoint for verifiable inferences
* Workspace management to help you with Giza Actions
* Actions jumpstart with `new` command to help you get started with your actions

In the future each new resource added to Giza will have its corresponding capability in the CLI.

## ✨ What's new?

For a detailed list of changes, please refer to the [CHANGELOG](../CHANGELOG.md) file.

## 💖 Join the community!

Join the community and help build a safer and transparent AI in our [Discord](https://discord.gg/Kt24CsMb5k)!

## ✍️ Authors & contributors

For a full list of all authors and contributors, see [the contributors page](https://github.com/gizatechxyz/giza-cli/graphs/contributors).

## License

This project is licensed under the **MIT license**.

See [LICENSE](../LICENSE/) for more information.
Please refer to the [updated documentation](https://docs.gizatech.xyz/), as the one you are consulting is outdated.
54 changes: 0 additions & 54 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,3 @@
## 🚀 Welcome

* [Giza CLI](README.md)
* [Installation](welcome/installation.md)
* [Authentication](welcome/authentication.md)
* [Frameworks](welcome/frameworks.md)
* [Actions](welcome/actions.md)

## 📦 Resources

* [Users](resources/users.md)
* [Models](resources/models.md)
* [Versions](resources/versions.md)
* [Workspaces](resources/workspaces.md)
* [Endpoints](resources/endpoints.md)
* [Agents](resources/agents.md)

## 📚 Frameworks

* [Cairo](frameworks/cairo/README.md)
* [Transpile](frameworks/cairo/transpile.md)
* [Deploy](frameworks/cairo/deploy.md)
* [Prove](frameworks/cairo/prove.md)
* [Verify](frameworks/cairo/verify.md)
* [EZKL](frameworks/ezkl/README.md)
* [Transpile](frameworks/ezkl/transpile.md)
* [Deploy](frameworks/ezkl/deploy.md)
* [Prove](frameworks/ezkl/prove.md)
* [Verify](frameworks/ezkl/verify.md)

## 📖 Examples

* [Basic Cairo CLI Example](examples/basic.md)
* [Reset Your Password](examples/reset\_password.md)

## 🧱 Reference

* [API Overview](reference/api/README.md)
* [callbacks](reference/api/callbacks.md)
* [cli](reference/api/cli.md)
* [client](reference/api/client.md)
* [commands](reference/api/commands.md)
* [commands.deploy](reference/api/commands.deploy.md)
* [commands.models](reference/api/commands.models.md)
* [commands.prove](reference/api/commands.prove.md)
* [commands.reset\_password](reference/api/commands.reset\_password.md)
* [commands.transpile](reference/api/commands.transpile.md)
* [commands.users](reference/api/commands.users.md)
* [commands.version](reference/api/commands.version.md)
* [commands.versions](reference/api/commands.versions.md)
* [commands.workspaces](reference/api/commands.workspaces.md)
* [exceptions](reference/api/exceptions.md)
* [options](reference/api/options.md)
* [utils.decorators](reference/api/utils.decorators.md)
* [utils.echo](reference/api/utils.echo.md)
* [utils.enum](reference/api/utils.enum.md)
* [utils](reference/api/utils.md)
116 changes: 0 additions & 116 deletions docs/examples/basic.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/examples/reset_password.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/frameworks/cairo/README.md

This file was deleted.

Loading

0 comments on commit 90d98d7

Please sign in to comment.