Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Default owners for everything in the repo
* @mooncitizen
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [lag-app]
36 changes: 16 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: ''
about: Report a bug to help us improve Lag CLI
title: "[BUG] "
labels: bug
assignees: mooncitizen

---
Expand All @@ -12,27 +12,23 @@ A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
1. Run `lag ...`
2. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Terminal output**
If applicable, paste the relevant terminal output or error messages. Use debug logging for more detail:
```bash
RUST_LOG=debug lag <command>
```

**Environment:**
- OS: [e.g. macOS 15.2, Ubuntu 24.04]
- Architecture: [e.g. arm64, x86_64]
- Lag CLI version: [e.g. 0.0.8-alpha — run `lag --version`]
- Installation method: [e.g. Homebrew, curl install script, from source]

**Additional context**
Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Lag Website
url: https://trylag.com
about: Visit the Lag website for more information
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
about: Suggest an idea for Lag CLI
title: ""
labels: enhancement
assignees: ""

---

Expand Down
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Summary

<!-- Brief description of the changes -->

## Changes

-

## How to test

<!-- Steps for reviewers to verify your changes -->

1.

## Checklist

- [ ] Code compiles without warnings (`cargo build --workspace`)
- [ ] Tests pass (`cargo test --workspace`)
- [ ] I have tested this on my platform (macOS / Linux)
87 changes: 87 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Contributing to Lag CLI

Thanks for your interest in contributing! We're a small team so PR reviews may take some time, but we appreciate every contribution.

## Getting Started

1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/<your-username>/cli.git
cd cli
```
3. Create a branch for your changes:
```bash
git checkout -b my-feature
```

## Development Setup

You'll need:
- [Rust](https://rustup.rs/) (stable toolchain)
- A C compiler (for native dependencies)
- CMake (for audio library builds)

Build and run:
```bash
cargo build -p lag-cli
cargo run -p lag-cli -- --help
```

Run tests:
```bash
cargo test --workspace
```

Enable debug logging:
```bash
RUST_LOG=debug cargo run -p lag-cli -- <command>
```

Point to a local API server for development:
```bash
lag config set api-url http://localhost:3001
```

## Project Structure

```
crates/
cli/ # Main CLI application
common/ # Shared types and utilities
voice-core/ # Voice chat engine
```

## Making Changes

- Keep PRs focused — one feature or fix per PR
- Follow existing code style and conventions
- Make sure `cargo build --workspace` compiles without warnings
- Make sure `cargo test --workspace` passes
- Test your changes on your platform (macOS or Linux)

## Commit Messages

Write clear, concise commit messages. Use the imperative mood:
- `fix: handle expired token on reconnect`
- `feat: add push-to-talk toggle command`
- `docs: update install instructions for arm64`

## Submitting a Pull Request

1. Push your branch to your fork
2. Open a PR against `main`
3. Fill out the PR template
4. Wait for review — we'll get to it as soon as we can

## Reporting Bugs

Use the [bug report template](https://github.com/lag-app/cli/issues/new?template=bug_report.md). Include your OS, architecture, CLI version (`lag --version`), and steps to reproduce.

## Requesting Features

Use the [feature request template](https://github.com/lag-app/cli/issues/new?template=feature_request.md).

## License

By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
Loading