Metadata-Version: 2.4
Name: byteask
Version: 0.1.3
Summary: ByteAsk - AI coding agent for your terminal (interactive TUI + C/C++ tooling).
Author: ByteAsk
Project-URL: Homepage, https://code.byteask.ai
Project-URL: Download, https://code.byteask.ai/install.sh
Keywords: byteask,ai,coding-agent,cli,tui,llm,agent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# ByteAsk

**An AI coding agent for your terminal.** Like Claude Code or Codex, `byteask` drops
a capable agent into your shell — an interactive TUI, real tool use, and first-class
C/C++ tooling — talking to the self-hosted ByteAsk gateway.

[![PyPI](https://img.shields.io/pypi/v/byteask.svg)](https://pypi.org/project/byteask/)
[![npm](https://img.shields.io/npm/v/@byteask/cli.svg)](https://www.npmjs.com/package/@byteask/cli)
[![Python](https://img.shields.io/pypi/pyversions/byteask.svg)](https://pypi.org/project/byteask/)

```console
$ byteask
```

That's it — one command drops you into an interactive session, the same way `claude`
or `codex` do. First run signs you in; after that, just type.

---

## Install

Pick whichever fits your setup — they all install the same native engine and share one
runtime, so switching between them is free.

**pip**
```bash
pip install byteask
```

**uv**
```bash
uv tool install byteask     # or:  uv pip install byteask   /   uvx byteask
```

**npm**
```bash
npm install -g @byteask/cli
# or, no install:
npx @byteask/cli
```

**Shell (Linux / macOS)**
```bash
curl -fsSL https://code.byteask.ai/install.sh | sh
```

**PowerShell (Windows)**
```powershell
irm https://code.byteask.ai/install.ps1 | iex
```

The `pip`, `uv`, and `npm` packages **bundle the native engine for your platform** —
`pip install` / `npm i` gets you a working tool with no extra download. (On a platform
without a prebuilt binary they fall back to fetching it once.) The installed command is
`byteask` on every path.

---

## Quickstart

```bash
# 1. Sign in (magic link to your email) — or just run `byteask`, it onboards you.
byteask login --email you@company.com

# 2. Start coding, interactively:
byteask

# 3. Or one-shot a question against the current repo:
byteask "explain what this service does and where the entrypoint is"
```

Inside the session, type your task in plain English. The agent reads files, runs
tools, and proposes edits — you stay in control of what it applies.

---

## Commands

| Command | What it does |
| --- | --- |
| `byteask` | Open the interactive agent (the default) |
| `byteask "…"` | Run a one-shot prompt against the current directory |
| `byteask login` | Sign in (magic link → token) |
| `byteask logout` | Sign out on this machine |
| `byteask --update` | Update to the latest engine |
| `byteask --version` | Print the version |

Inside the TUI, slash commands include **`/login`**, **`/logout`**, **`/usage`** (your
quota), **`/upgrade`** (Pro / Max), **`/referral-code`**, and **`/status`**.

---

## What you get

- **Interactive TUI** — a real terminal agent, not a chat box: it navigates the repo,
  runs commands, and shows diffs before applying.
- **First-class C/C++ tooling** — 16 native tools wired in: Compiler Explorer
  (godbolt), `gdb`/`lldb`, ASan/UBSan/valgrind, `clang-tidy`, `clang-format`, `clangd`
  navigation, `perf`/callgrind, quick-bench, cppinsights, objdump/nm/readelf, Intel
  intrinsics lookup, and more. The agent reaches for them on the tasks that need them.
- **Web search** built in.
- **Zero data retention** — your prompts and code are not used to train models.
- **Usage that's visible** — `/usage` shows exactly where you stand; upgrade in-app
  with `/upgrade`.

---

## Platforms

| OS | Architecture | libc |
| --- | --- | --- |
| Linux | x86_64, arm64 | glibc |
| macOS | Apple Silicon (arm64) | — |
| Windows | x86_64 | — |

> Alpine / musl isn't supported (a core dependency ships no musl build). On Alpine,
> use WSL or a glibc base image.

---

## How it works

`byteask` is a thin client. The intelligence and your account live behind the ByteAsk
gateway; the local binary is the agent runtime plus a small launcher that handles
sign-in, updates, and your config in `~/.byteask`. Your model key never touches your
machine.

---

## Links

- Home: <https://code.byteask.ai>
- Install script: <https://code.byteask.ai/install.sh>

© ByteAsk. All rights reserved.
