Metadata-Version: 2.4
Name: friday-ai-teammate
Version: 0.0.2
Summary: Friday AI Teammate - A powerful AI coding assistant for your terminal
Author-email: mk-knight23 <mk-knight23@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/mk-knight23/Friday
Project-URL: Repository, https://github.com/mk-knight23/Friday
Project-URL: Issues, https://github.com/mk-knight23/Friday/issues
Keywords: ai,assistant,cli,coding,agent,llm,terminal
Classifier: Development Status :: 3 - Alpha
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: openai>=1.0.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: tomli>=2.0.0
Requires-Dist: httpx>=0.25.0
Requires-Dist: ddgs>=6.0.0
Requires-Dist: fastmcp>=0.4.0
Requires-Dist: tiktoken>=0.5.0
Requires-Dist: python-dotenv>=1.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: build>=1.0.0; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Dynamic: license-file

# Friday AI Teammate

[![PyPI version](https://badge.fury.io/py/friday-ai-teammate.svg)](https://pypi.org/project/friday-ai-teammate/)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Friday is a powerful AI assistant designed to help you with coding tasks, file management, and information retrieval directly from your terminal.

## Installation

```bash
pip install friday-ai-teammate
```

## Quick Start

### 1. Configuration
Set up your API key:
```bash
export API_KEY=your_sk_...
export BASE_URL=https://api.minimax.io/v1  # or your preferred provider
```

Or create a `.env` file in your working directory:
```env
API_KEY=your_sk_...
BASE_URL=https://api.minimax.io/v1
```

### 2. Usage

**Interactive Mode** - Launch the interactive shell:
```bash
friday
```

**Single Prompt** - Run a specific task:
```bash
friday "Scan the current directory for security risks"
```

**Options**:
- `-c, --cwd DIRECTORY`: Set the working directory for the agent
- `--help`: Show available options

## Built-in Tools

Friday comes equipped with a suite of tools:

| Category | Tools |
|----------|-------|
| **File System** | `read_file`, `write_file`, `edit_file`, `list_dir`, `glob` |
| **Search** | `grep` for pattern matching |
| **Shell** | `shell` to execute system commands safely |
| **Web** | `web_search` and `web_fetch` |
| **Memory** | `memory` to store and retrieve context |
| **Tasks** | `todos` to manage work lists |

## Security Features

- **Secret Scrubbing**: Automatically masks sensitive information (API keys, passwords) in tool outputs
- **Approval Policies**: Configure how the agent asks for permission before executing dangerous commands (`/approval`)
- **Path Validation**: Operations are restricted to allowed directories to protect your system

## Development

### From Source
```bash
git clone https://github.com/mk-knight23/Friday.git
cd Friday
pip install -e ".[dev]"
```

### Running Tests
```bash
pytest tests/ -v
```

## License

MIT
