kagisearch 0.3.0

A Rust library that allows you to perform Kagi searches programmatically using chromiumoxide, without consuming additional API credits.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# Kagi Search 🔍

[![Behavior Test](https://github.com/the-alchemists-of-arland/kagisearch/actions/workflows/test_behavior.yaml/badge.svg?branch=main)](https://github.com/the-alchemists-of-arland/kagisearch/blob/main/.github/workflows/test_behavior.yaml)
[![Crates.io](https://img.shields.io/crates/v/kagisearch.svg)](https://crates.io/crates/kagisearch)
[![Documentation](https://docs.rs/kagisearch/badge.svg)](https://docs.rs/kagisearch)
[![License](https://img.shields.io/badge/license-Apache-blue.svg)](LICENSE)

A Rust library that allows you to perform Kagi searches programmatically using chromiumoxide, without consuming additional API credits.

## ✨ Features

- 💳 No additional API credits required
- 🔐 Supports token-based, F2A-based and cookie-based authentication
- 🕵️ Incognito mode allows you to perform searches without saving your authentication.

## 📦 Installation

Add `kagisearch` to your `Cargo.toml`:

```toml
[dependencies]
kagisearch = "0.3"
```

async-std users should use the `async-std-runtime` feature:

```toml
[dependencies]
kagisearch = { version = "0.3", features = ["async-std-runtime"], default-features = false }
```

## 🚀 Quick Start

```rust
use kagisearch::{AuthType, Kagi};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Initialize the browser with your Kagi token
    let kagi = Kagi::new(AuthType::Token("your_token_here".to_string())).await?;
    // Perform a search and get up to 5 results
    let results = kagi.search("Rust programming language", 5, None).await?;

    let Some(results) = results else {
        return Err(anyhow::anyhow!("No search results found"));
    };

    // Print the results
    for result in results {
        println!("{:?}", result);
    }

    kagi.close().await?;

    Ok(())
}
```

## 📖 Documentation

For more detailed examples and usage instructions, check out:
- [Examples directory](./examples)
- [API Documentation](https://docs.rs/kagisearch)

## 🤝 Contributing

Contributions are welcome! Feel free to:
1. Fork the repository
2. Create a new branch for your feature
3. Submit a Pull Request

Please make sure to update tests as appropriate.

## Credits

- [chromiumoxide](https://github.com/mattsse/chromiumoxide)
- [google-search](https://github.com/web-agent-master/google-search)

## ⚖️ License

This project is licensed under the [Apache License](LICENSE).

## 📝 Note

> While Kagi is an excellent search engine, their API pricing can be cost-prohibitive. This library provides a way to integrate Kagi search functionality into your applications without incurring additional API costs beyond your Professional subscription.