Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 4.75 KB

README.md

File metadata and controls

116 lines (80 loc) · 4.75 KB

Giza Command Line Interface

GitHub Workflow Status Project license Pull Requests welcome Join the community

All Contributors

  _______  __   ________      ___           ______  __       __
 /  _____||  | |       /     /   \         /      ||  |     |  |
|  |  __  |  | `---/  /     /  ^  \       |  ,----'|  |     |  |
|  | |_ | |  |    /  /     /  /_\  \      |  |     |  |     |  |
|  |__| | |  |   /  /----./  _____  \     |  `----.|  `----.|  |
 \______| |__|  /________/__/     \__\     \______||_______||__|

Welcome to Giza CLI!

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

Disclaimer: this is still in an experimental stage so the functionality is subject to change.

🚀 Installation

Recommended installation with pipx

pipx allows to install the dependency in an isolated environment. With this we can make sure that it does not conflict with any of our installed dependencies.

pipx install giza-cli

Install from PyPi

For the latest release:

pip install giza-cli

Installing from source

Clone the repository and install it with pip:

    git clone [email protected]:gizatechxyz/giza-cli.git
    cd giza-cli
    pip install .

Or install it directly from the repo:

  pip install git+ssh://[email protected]/gizatechxyz/giza-cli.git

📚 Documentation

You can check our official docs here.

  • Examples includes examples on how to use the CLI functionalities.

  • Resources brings the documentation of the different resources and actions that can be done with the CLI.

  • 🧠 Reference for the API reference and internals of the CLI.

🌟 What's new

For a detailed list of changes, please refer to the CHANGELOG file.

🤝 Join the community!

Join the community and help build a safer and transparent AI in our Discord!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gonzalo Mellizo
Gonzalo Mellizo

💻
omahs
omahs

📖
Fran Algaba
Fran Algaba

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT