Metadata-Version: 2.4
Name: linkup-cli
Version: 0.3.0
Summary: Official CLI for Linkup - AI-powered web search
Project-URL: Homepage, https://linkup.so
Project-URL: Documentation, https://docs.linkup.so
Project-URL: Repository, https://github.com/LinkupPlatform/linkup-cli
Project-URL: Issues, https://github.com/LinkupPlatform/linkup-cli/issues
Author-email: Linkup <support@linkup.so>
License-Expression: MIT
Keywords: ai,cli,linkup,search,web-search
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Requires-Python: >=3.9
Requires-Dist: linkup-sdk>=0.2.0
Requires-Dist: rich>=13.0.0
Description-Content-Type: text/markdown

# Linkup CLI

Official command-line interface for [Linkup](https://linkup.so) - AI-powered web search.

## Installation

```bash
pip install linkup-cli
```

## Quick Start

1. Get your API key at [app.linkup.so](https://app.linkup.so)

2. Set your API key:
```bash
export LINKUP_API_KEY="your-api-key"
```

3. Search:
```bash
linkup search "What is the capital of France?"
```

## Usage

### Search

```bash
# Basic search (standard depth, sourced answer)
linkup search "your query"

# Deep search (more thorough, better for complex queries)
linkup search "complex research topic" --depth deep

# Get raw search results instead of AI answer
linkup search "python tutorials" --output searchResults

# Combine options
linkup search "latest AI research" --depth deep --output searchResults

# Short form
linkup s "your query" -d deep -o searchResults
```

### Fetch

Extract content from any URL:

```bash
linkup fetch "https://example.com"
```

### Configuration

Check your configuration:

```bash
linkup config
```

## Options

| Flag | Short | Values | Description |
|------|-------|--------|-------------|
| `--depth` | `-d` | `fast`, `standard`, `deep` | Search depth (default: standard) |
| `--output` | `-o` | `sourcedAnswer`, `searchResults` | Output type (default: sourcedAnswer) |
| `--version` | `-V` | | Show version |
| `--help` | `-h` | | Show help |

## Environment Variables

| Variable | Description |
|----------|-------------|
| `LINKUP_API_KEY` | Your Linkup API key (required) |

## Examples

```bash
# Quick facts
linkup search "population of tokyo"

# Research
linkup search "latest developments in quantum computing" --deep

# Get sources
linkup search "best python web frameworks" --results

# Extract article content
linkup fetch "https://example.com/article"
```

## Links

- [Linkup Website](https://linkup.so)
- [Documentation](https://docs.linkup.so)
- [Get API Key](https://app.linkup.so)
- [Python SDK](https://github.com/LinkupPlatform/linkup-python-sdk)

## License

MIT
