Add CLI tests

Author: rikhuijzer

Cargo.toml

@@ -7,8 +7,10 @@ license = "MIT"
 
 [dependencies]
 clap = { version = "4.5.29", features = ["derive"] }
-transformrs = "0.5.0"
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
+transformrs = "0.5.0"
 
 [dev-dependencies]
+assert_cmd = "2"
+predicates = "3"
 pretty_assertions = "1"

README.md

@@ -1,83 +1,24 @@
-
-<h1 align="center"><b>
-  NOTE
-</b></h1>
-
-<h3 align="center">
-  Instead of using <code>ata</code>, I would advice most people to use 
-  <a href="https://github.com/simonw/llm"><code>llm</code></a>
-  by Simon Willison instead.
-  It supports more models and ways to interact with models.
-</h3>
-
-<br>
-<br>
-<br>
-
 <h1 align="center"><code>ata</code>: Ask the Terminal Anything</h1>
 
-<h3 align="center">ChatGPT in the terminal</h3>
-
-<p align="center">
-  <a href="https://asciinema.org/a/565384"><img src="https://asciinema.org/a/565384.svg" alt="asciicast"></a>
-</p>
-
-<h3 align=center>
-TIP:<br>
-  Run a terminal with this tool in your background and show/hide it with a keypress.<br>
-    This can be done via: Iterm2 (Mac), Guake (Ubuntu), scratchpad (i3/sway), or the quake mode for the Windows Terminal.
-</h3>
-
-## Productivity benefits
-
-- The terminal starts more quickly and requires **less resources** than a browser.
-- The **keyboard shortcuts** allow for quick interaction with the query. For example, press `CTRL + c` to cancel the stream, `CTRL + ↑` to get the previous query again, and `CTRL + w` to remove the last word.
-- A terminal can be set to **run in the background and show/hide with one keypress**. To do this, use iTerm2 (Mac), Guake (Ubuntu), scratchpad (i3/sway), or the quake mode for the Windows Terminal.
-- The prompts are **reproducible** because each prompt is sent as a stand-alone prompt without history. Tweaking the prompt can be done by pressing `CTRL + ↑` and making changes.
-
-## Usage
+<h3 align="center">Use AI in the terminal</h3>
 
-Download the binary for your system from [Releases](https://github.com/rikhuijzer/ata/releases).
-Or use your package manager to install the application.
-For example, Brew on MacOS or AUR on Arch Linux have packages available.
+## Philosophy
 
-To specify the API key and some basic model settings, start the application.
-It should give an error and the option to create a configuration file called `ata.toml` for you.
-Press `y` and `ENTER` to create a `ata.toml` file.
+The philosophy of this project is mainly to not handle state.
+Like curl or ffmpeg, this should make it easier to use in scripts and to share examples online.
+Settings are done via command line arguments and environment variables.
 
-Next, request an API key via <https://platform.openai.com/api-keys> and update the key in the example configuration file.
-They key permissions can be "Restricted" to only "Model capabilities".
+## Goals (not implemented yet)
 
-For more information, see:
+Use the OpenAI API to generate audio from text (text to speech).
 
 ```sh
-$ ata --help
+$ OPENAI_KEY=<KEY> cat myfile.txt | ata --tts
 ```
 
-## FAQ
-
-**How much will I have to pay for the API?**
-
-Using OpenAI's API for chat is very cheap.
-Let's say that an average response is about 500 tokens, so costs about $0.015 (with GPT-4).
-That means that if you do 50 requests per day, then that will cost you about $0.75 per day ($15 per month assuming you only use it only on workdays).
-If you use GPT-3.5, then the costs will be much lower.
-
-**How does this compare to LLM-based search engines such as You.com or Bing Chat?**
-
-At the time of writing, the OpenAI API responds much quicker than the large language model-based search engines and contains no adds.
-It is particularly useful to quickly look up some things like Unicode symbols, historical facts, or word meanings.
-
-**Can I build the binary myself?**
-
-Yes, you can clone the repository and build the project via [`Cargo`](https://github.com/rust-lang/cargo).
-Make sure that you have `Cargo` installed and then run:
+Here, `ata` will try to do `tts` (text to speech) on the input text.
+Because only the `OPENAI_KEY` is provided, it will use some default OpenAI model to get the audio.
 
 ```sh
-$ git clone https://github.com/rikhuijzer/ata.git
-
-$ cd ata/
-
-$ cargo build --release
+$ OPENAI_KEY=<KEY> cat myfile.txt | ata --tts --voice=ash
 ```
-After this, your binary should be available at `target/release/ata` (Unix-based) or `target/release/ata.exe` (Windows).

src/main.rs

@@ -1,3 +1,37 @@
-fn main() {
-    println!("Hello, world!");
+use clap::Parser;
+use std::io::{self, Read};
+
+#[derive(Parser)]
+#[command(author, version, about = "Ask the Terminal Anything - Use AI in the terminal")]
+struct Arguments {
+    /// Enable text-to-speech conversion
+    #[arg(long)]
+    tts: bool,
+
+    /// Voice to use for text-to-speech (optional)
+    #[arg(long)]
+    voice: Option<String>,
+}
+
+#[tokio::main]
+async fn main() {
+    let args = Arguments::parse();
+
+    // Read all input from stdin
+    let mut input = String::new();
+    io::stdin().read_to_string(&mut input).unwrap();
+
+    // TODO: add logic to transformrs to just get the key without .env file.
+    let _openai_key = std::env::var("OPENAI_KEY").expect("OPENAI_KEY must be set");
+
+    if args.tts {
+        if let Some(voice) = args.voice {
+            todo!("Implement TTS with voice: {}", voice);
+        } else {
+            todo!("Implement TTS with default voice");
+        }
+    } else {
+        eprintln!("No action specified. Use --tts to convert text to speech.");
+        std::process::exit(1);
+    }
 }

tests/cli.rs

@@ -0,0 +1,28 @@
+use assert_cmd::prelude::*;
+use predicates::prelude::*;
+use std::process::Command;
+
+#[test]
+fn unexpected_argument() -> Result<(), Box<dyn std::error::Error>> {
+    let mut cmd = Command::cargo_bin("ata")?;
+
+    cmd.arg("foobar");
+    cmd.assert()
+        .failure()
+        .stderr(predicate::str::contains("unexpected argument"));
+
+    Ok(())
+}
+
+
+#[test]
+fn help() -> Result<(), Box<dyn std::error::Error>> {
+    let mut cmd = Command::cargo_bin("ata")?;
+
+    cmd.arg("--help");
+    cmd.assert()
+        .success()
+        .stdout(predicate::str::contains("Usage: ata"));
+
+    Ok(())
+}