couik

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #android #rust #deep-learning #linux #docker #java #awesome #vue #security #mcp

(★ 84)

your typing experience brought to the terminal

couik 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Couik

**The modern, fast, and beautiful TUI typing speed test.**

[![Go Report Card](https://goreportcard.com/badge/github.com/fadilix/couik)](https://goreportcard.com/report/github.com/fadilix/couik)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![AUR version](https://img.shields.io/aur/version/couik-bin)](https://aur.archlinux.org/packages/couik-bin)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/fadilix/couik)](https://github.com/fadilix/couik/releases)

</div>

---

## Overview

**Couik** is a terminal-based typing test designed for speed, aesthetics, and simplicity. Built with [Bubble Tea](https://github.com/charmbracelet/bubbletea), it provides a smooth and responsive experience right in your CLI.

Whether you want to warm up before coding, challenge your friends, or just track your WPM progress, Couik has you covered.

## Features

- **Timed Mode**: Test yourself against the clock (`15s`, `30s`, `60s`, `120s`).
- **Word Mode**: Practice with a set number of words (`10`, `25`, `50`, `100`).
- **Custom Text**: Load your own text files or paste custom strings.
- **Ghost Mode**: Race a translucent replay of your last run on the same text — see exactly where you slowed down or sped up, and try to beat it. Toggle with `Ctrl+H` mid-run, or `couik config set ghost off` to disable.
- **History Tracking**: Keep track of your progress over time with built-in stats.
- **Beautiful UI**: Modern, clean interface with real-time feedback.
- **Cross-Platform**: Works on Linux, macOS, and Windows.

## Installation

### Linux

#### Quick Install (recommended)

```bash
curl -fsSL https://raw.githubusercontent.com/Fadilix/couik/main/scripts/install.sh | bash
```

> Automatically detects your CPU architecture (`x86_64` / `arm64`) and installs the right binary to `/usr/local/bin`.  
> On **Arch Linux** it will use your AUR helper (`yay`, `paru`, …) if one is found.

#### Arch Linux (AUR)

```bash
yay -S couik-bin
```

#### Debian / Ubuntu

Download the `.deb` file from [Releases](https://github.com/fadilix/couik/releases) and run:

```bash
sudo apt install ./couik_*_linux_amd64.deb
```

#### Fedora / RHEL

Download the `.rpm` file from [Releases](https://github.com/fadilix/couik/releases) and run:

```bash
sudo dnf install ./couik_*_linux_amd64.rpm
```

#### Binary (Generic)

```bash
tar -xzf couik_*_linux_amd64.tar.gz
sudo mv couik /usr/local/bin/
```

### Docker

Requires [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).

Build the image and run an interactive typing session (history persists across runs in the `couik-vol` named volume):

```bash
docker compose run --rm --build couik
```

> The first run builds the image (around a minute) and creates `couik-vol`. Subsequent runs are instant.

Pass any couik flag after the service name:

```bash
docker compose run --rm couik --history
docker compose run --rm couik -c "the quick brown fox"
```

To run on a locally built image without Compose:

```bash
docker build -t couik:local .
docker run -it --rm \
  -e XDG_CONFIG_HOME=/couik \
  -v couik-vol:/couik \
  couik:local
```

> The `-it` flags allocate a TTY so the Bubble Tea UI can render. `--rm` removes the container when you exit. The volume keeps your history and config between runs.

### Windows (Download the realease file or build using docker)

1. Download the `.zip` archive from [Releases](https://github.com/fadilix/couik/releases).
2. Extract and run `couik.exe`.
3. (Optional) Add to your PATH for global access.

### macOS

Download the binary from [Releases](https://github.com/fadilix/couik/releases) or use Go:

```bash
go install github.com/fadilix/couik/cmd/couik@latest
```

### Build from Source

Requires [Go 1.21+](https://go.dev/dl/).

```bash
go install github.com/fadilix/couik/cmd/couik@latest
```

## Usage

Simply run `couik` to start a default session.

```bash
couik [flags]
```

### Command Flags

| Flag        | Short | Description                            | Example                             |
| ----------- | ----- | -------------------------------------- | ----------------------------------- |
| `--time`    | `-t`  | Run a timed test (seconds)             | `couik -t 60`                       |
| `--words`   | `-w`  | Run a word count test                  | `couik -w 50`                       |
| `--file`    | `-f`  | Use a custom text file                 | `couik -f ./code.txt`               |
| `--custom`  | `-c`  | Use a custom string                    | `couik -c "Hello World"`            |
| `--lang`    | `-l`  | Set the language (`english`, `french`) | `couik -l french`                   |
| `--host`    | `-p`  | Host a multiplayer game on a port      | `couik -p 4242 -n Alice`            |
| `--join`    | `-j`  | Join a multiplayer game (`ip:port`)    | `couik -j 192.168.1.10:4242 -n Bob` |
| `--name`    | `-n`  | Your display name in multiplayer       | `couik -n Alice`                    |
| `--history` | `-i`  | View your past results                 | `couik -i`                          |
| `--help`    | `-h`  | Show help message                      | `couik -h`                          |

### Controls

#### General

| Key              | Action                                             |
| ---------------- | -------------------------------------------------- |
| Start typing     | The test begins immediately                        |
| `ESC` / `Ctrl+C` | Quit the application                               |
| `Ctrl+R`         | Restart the test with a new text                   |
| `Tab`            | Restart the test (on results screen)               |
| `Ctrl+L`         | Restart with the **same** text (on results screen) |
| `Shift+Tab`      | Open / close the mode selector                     |
| `←` / `h`        | Move selector left                                 |
| `→` / `l`        | Move selector right                                |
| `Enter`          | Confirm selection                                  |
| `Ctrl+N`         | Toggle language (English ↔ French)                 |
| `Ctrl+E`         | Open / close the quote type selector               |
| `Ctrl+P`         | Open command palette                               |
| `Ctrl+G`         | Open configuration view                            |
| `Ctrl+H`         | Toggle Ghost Mode (only on the typing screen)      |

#### Multiplayer (lobby)

| Key              | Action                                         |
| ---------------- | ---------------------------------------------- |
| `Ctrl+J`         | **(Host only)** Start the game for all players |
| `ESC` / `Ctrl+C` | Leave the lobby and quit                       |

## Configuration

You can customize `couik` using the `config` subcommand.

```bash
couik config set [key] [value]
```

### Available Settings

### Custom Dashboard Art

You can personalize the dashboard by adding your own ASCII art. Simply create a text file with your art and point `couik` to it.

To set a custom ASCII logo, use the following command:

```bash
couik config set dashboard_ascii /path/to/your/ascii.txt
```

Alternatively, you can manually edit the configuration file (typically located at `/home/username/.config/couik/config.yaml` on Linux):

```yaml
mode: ""
dashboard_ascii: /home/username/.config/couik/logo.txt
quote_type: ""
time: ""
```

### Subcommands

- `config`: Configure your preferences.
- `completion`: Generate autocompletion scripts.

## Multiplayer

Couik supports real-time multiplayer typing races over TCP. One player hosts the session and others join using the host's local IP address.

### Hosting a game

```bash
couik --host <port> --name <YourName>
# short form:
couik -p 4242 -n Alice
```

This starts a server on the given port, puts you in the lobby, and waits for players to connect. Once everyone is ready, press **`Ctrl+J`** to send the text to all players and start the countdown.

### Joining a game

```bash
couik --join <host-ip>:<port> --name <YourName>
# short form:
couik -j 192.168.1.42:4242 -n Bob
```

Connect to a running host using their local IP address and the port they chose. You will be placed in the lobby automatically. The game starts when the host presses `Ctrl+J`.

### Multiplayer flow

1. **Host** runs `couik -p <port> -n <name>`.
2. **Guests** run `couik -j <host-ip>:<port> -n <name>`.
3. All players appear in the lobby. The host sees `ctrl+j  start game`.
4. Host presses `Ctrl+J` — a 5-second countdown begins for everyone.
5. All players type the same text simultaneously; progress bars update in real time.
6. After the round, the host can press `Ctrl+J` again to start a new round.

> **Note:** Multiplayer uses a direct TCP connection. Make sure the port is open on the host's firewall and that all players are on the same network (or the host has port-forwarded for internet play).

## Contributing

First off, thanks for taking the time to contribute! We welcome all contributions, big or small.

### Development Setup

1. **Fork** the repository on GitHub.
2. **Clone** your fork locally:

```bash
   git clone https://github.com/YOUR_USERNAME/couik.git
   cd couik
   ```

3. **Run** the project locally to ensure everything works:

```bash
   go run cmd/couik/main.go
   ```

### Pull Requests

When you are ready to make a change, follow these steps:

1. **Open an Issue**: Every new feature or bug fix should be linked to an issue. Please open an issue first to discuss your proposed changes before writing code.
2. **Create a branch**: Create a new branch for your feature or bugfix.

```bash
   git checkout -b feat/my-cool-feature
   ```

3. **Make your changes**: Write your code and make sure to use clear, descriptive commit messages (e.g., `feat: add awesome feature (#20)`).
4. **Test your code**: Ensure the code builds and runs properly without breaking existing functionality.
5. **Submit a PR**: Push to your fork and submit a Pull Request against the main repository.

### Issues

If you find a bug or have a feature request, [open an issue](https://github.com/fadilix/couik/issues) on GitHub. Include as much detail as possible to help us understand the problem or request.

couik

couik 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

couik

couik 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README