Skip to main content

Distraction-free DSA practice in your terminal

Project description

grindx

Distraction-free DSA practice in your terminal.

Python 3.10+ License: MIT

grindx demo

Why grindx?

  • Local-first — problem browsing, progress, and solutions stay local; AI review and testcase bundle downloads are optional
  • Terminal-native — practice DSA without leaving your terminal or opening a browser
  • Multiple sheets — Striver A2Z (316), Blind 75, NeetCode 150, Grind 75 built-in
  • 5 languages — Python, Go, C++, Java, JavaScript — switch on the fly with Ctrl+L
  • Progress tracking — solved/in-progress/not-started states, streaks, best times
  • Bookmarks & filters — filter by difficulty (Easy/Medium/Hard) or bookmarked problems

Install

pip install grindx

Or with pipx (recommended for CLI tools):

pipx install grindx

Or run from source:

git clone https://github.com/xghostient/grindx.git
cd grindx
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
grindx

Local testcase bundle

PyPI installs keep the package lean and do not ship the full bundled testcase corpus. To enable local Ctrl+R test runs, fetch the external testcase bundle once:

grindx --fetch-testcases

By default this pulls from:

https://github.com/grindxhq/dsa-catalog/releases/latest/download/manifest.json

Override the manifest source if needed:

grindx --fetch-testcases --testcase-manifest-url https://example.com/manifest.json
# or
export GRINDX_TESTCASE_MANIFEST_URL=https://example.com/manifest.json

Usage

grindx            # CLI entry point
python -m grindx  # or as a module

Navigation

Key Action
Navigate topics / problems
Switch between topic and problem panes
Enter Select topic or open problem
Esc Go back
q Quit

Filters

Key Filter
a All problems
e Easy
m Medium
h Hard
b Bookmarked
s Stats dashboard

Solve Screen

Key Action
Ctrl+S Save code
Ctrl+D Toggle solved
Ctrl+E AI review
Ctrl+L Cycle language (Python → Go → C++ → Java → JS)
Ctrl+B Toggle bookmark
Ctrl+T Pause / resume timer
Ctrl+R Run tests
Ctrl+Shift+R Reset timer
Ctrl+Shift+C Copy selection to clipboard
Ctrl+Shift+V Paste from clipboard
Alt+↑ / Alt+↓ Move line up / down
Alt+Shift+↓ Duplicate line
Esc Save & go back

Features

Split-pane editor — problem description on the left, code editor with syntax highlighting on the right.

Auto-timer — starts when you open a problem, tracks your best solve time.

Three-state tracking — each problem shows as not started (○), in progress (◐), or solved (✓).

Stats dashboard — overall progress, per-difficulty breakdown, per-topic progress bars, current streak, and top 10 best times.

Sheet-agnostic — built-in sheets live inside the package (grindx/sheets/). Format:

{
  "Topic Name": ["problem-name-1", "problem-name-2"],
  "Another Topic": ["problem-name-3"]
}

Progress safety — automatic backups with corruption recovery. Progress, solutions, backups, and downloaded testcase bundles are stored in ~/.grindx/ so they persist across installs and upgrades.

AI Review (optional)

Press Ctrl+E on the solve screen to get AI-powered feedback on your solution — correctness, edge cases, complexity analysis, and a pass/fail verdict.

Setup

Set two environment variables:

export GRINDX_AI_PROVIDER=groq              # or ollama, anthropic, openai
export GRINDX_AI_MODEL=llama-3.3-70b-versatile  # optional, sensible defaults per provider
export GRINDX_AI_KEY=gsk_...                # not needed for ollama
export GRINDX_AI_URL=https://custom.api/v1  # optional, auto-detected per provider

Or create ~/.grindx.toml:

[ai]
provider = "groq"
model = "llama-3.3-70b-versatile"
api_key = "gsk_..."

Supported Providers

Provider API Key Default Model Notes
ollama No llama3 Local, free, no network
groq Yes llama-3.3-70b-versatile Fast, free tier available
anthropic Yes claude-sonnet-4-20250514 Claude
openai Yes gpt-4o GPT

Any OpenAI-compatible API works — set provider to openai and add base_url.

Custom Sheets & Problems

You can add your own problem sheets and problems alongside the built-in ones.

Custom sheet

Create a JSON file in ~/.grindx/sheets/:

// ~/.grindx/sheets/my-list.json
{
  "Arrays": ["two-sum", "best-time-to-buy-and-sell-stock", "my-custom-problem"],
  "Strings": ["valid-anagram", "another-custom-problem"]
}

You can mix built-in problem IDs (like two-sum) with your own custom problem IDs. Run grindx --list-problems to see all available built-in problem IDs.

Custom problems

Create a folder per problem under ~/.grindx/problems/:

// ~/.grindx/problems/my-custom-problem/problem.json
{
  "id": "my-custom-problem",
  "name": "My Custom Problem",
  "difficulty": "Medium",
  "category": "Arrays",
  "description": "Given an array of integers, find ...",
  "examples": [
    {"input": "nums = [1, 2, 3]", "output": "6"},
    {"input": "nums = []", "output": "0"}
  ],
  "constraints": "1 <= nums.length <= 10^4",
  "python_template": "def solve(nums):\n    pass\n",
  "go_template": "func solve(nums []int) int {\n\n}\n",
  "cpp_template": "int solve(vector<int>& nums) {\n\n}\n",
  "java_template": "class Solution {\n    public int solve(int[] nums) {\n\n    }\n}\n",
  "js_template": "function solve(nums) {\n\n}\n"
}

Optional local judge assets for a custom problem:

~/.grindx/problems/my-custom-problem/testcases.json
~/.grindx/problems/my-custom-problem/judges/python.py
~/.grindx/problems/my-custom-problem/judges/go.go
~/.grindx/problems/my-custom-problem/judges/cpp.cpp
~/.grindx/problems/my-custom-problem/judges/java.java
~/.grindx/problems/my-custom-problem/judges/javascript.js

You only need to include the template keys and local judge assets for the languages you care about.

Legacy ~/.grindx/problems/custom.json is still loaded for compatibility, but new custom problems should use the folder-based format above.

Custom sheets show up on the dashboard alongside the built-in ones.

Built with

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grindx-0.2.5.tar.gz (773.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grindx-0.2.5-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file grindx-0.2.5.tar.gz.

File metadata

  • Download URL: grindx-0.2.5.tar.gz
  • Upload date:
  • Size: 773.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for grindx-0.2.5.tar.gz
Algorithm Hash digest
SHA256 18f34cd9f91c6d242705e888348eec12b5d31cdcee56063b400e9bf2bd3f4d61
MD5 3f6dfd69867553864f5e03e02e1ad743
BLAKE2b-256 a9df53505ce03627853f7357fe4399e88e0d098167c5f1ceda5e9a24ba2a5da9

See more details on using hashes here.

Provenance

The following attestation bundles were made for grindx-0.2.5.tar.gz:

Publisher: publish.yml on xghostient/grindx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file grindx-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: grindx-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for grindx-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 04d5eda4f97bd05234fd1c5fd6175d47846546cdadb7c737c32c48f4f714997a
MD5 df069982ea2e2b8eb93582c059c190b1
BLAKE2b-256 9060f09f1af0edc5299dae1fed3324f31d1edec3abc67932d9e4f5722b7fb52d

See more details on using hashes here.

Provenance

The following attestation bundles were made for grindx-0.2.5-py3-none-any.whl:

Publisher: publish.yml on xghostient/grindx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page