# Ojos CLI

![Ojos Project header](https://ojosproject.org/images/header.png)

## Table of Contents

- [Ojos CLI](#ojos-cli)
  - [Table of Contents](#table-of-contents)
  - [Description](#description)
    - [Features](#features)
  - [Visuals](#visuals)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Support](#support)
  - [License](#license)

## Description

The Ojos CLI is a tool meant to help members of the Ojos Project at the
University of California, Irvine.

### Features

- Create a new page for frontend development
- Manage the configuration and publishing of our email newsletter

## Visuals

![Ojos CLI visual running `ojos --help`](.github/assets/visual.png)

## Installation

You can install the Ojos CLI by running this command:

```shell
cargo install --git https://github.com/ojosproject/cli --branch release
```

## Usage

You can read the full API documentation in the [`api.md` file](./docs/api.md).

## Support

If you need help with the program, please run any of the following commands:

- `ojos --help`
- `ojos frontend --help`
- `ojos newsletter --help`

## License

[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
