Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 8.35 KB

README.md

File metadata and controls

95 lines (72 loc) · 8.35 KB

cstudy: Learn it. Practice it. Prove it.

CI Release License: MIT Homebrew

coding-study

Free study and interview prep for engineers: guides that teach each idea, problems graded by real tests, and timed mock interviews. In your editor or your browser. coding-study is a local, IDE-first study tool for everyone who writes code, from beginners to experts, covering algorithms, backend design, concurrency, code review, interview practice, and security and AI problems. You solve original problems in your own editor in Python, TypeScript, Java, Kotlin, Go, or Rust, and the cstudy command line tests your code, checks whether it is optimal, shows reference solutions, and schedules reviews with spaced repetition. Everything runs on your machine; there is no account and no service.

The website, coding-study.com, has the install guide and the usage docs.

  • Your editor, real toolchains. Each language is an ordinary project (uv, pnpm, Gradle) that your editor and its language server open directly.
  • More than algorithms. Data structures and algorithms, multi-level practical problems, low-level design, concurrency, debugging, system design, and code review.
  • Optimality, not only correctness. cstudy bench measures how your solution grows with input size and compares it with the reference approaches.
  • Spaced repetition. cstudy next resumes what you have open, brings back what is due and picks new problems from your weakest pattern.
  • Code intelligence in the browser, when you want it. The practice page can show errors as you type, documentation on hover, go to definition and completion for Python, TypeScript, Java, Go and Rust from language servers on your computer. Each is a setting, off by default, so you can also practice without any help.
  • AI review, opt-in, with your own key. A preview you turn on gives a second opinion on your system design and code review notes, criterion by criterion against the rubric, from the AI provider you choose. It asks before anything is sent, keeps to a daily token cap and never changes a grade; off, nothing leaves your machine.

Install

brew install bkuberek/tap/cstudy
cstudy --version

Or uv tool install git+https://github.com/bkuberek/coding-study (or the same with pipx install). cstudy runs your code with each language's own toolchain, which you install yourself: uv and Python 3.13 are required, the others only for the languages you use (install the language toolchains).

Upgrading from an earlier 0.x? UPGRADING.md lists what changed on the way to 1.0 and what to do about each change.

Quickstart

cstudy init ~/cstudy-workspace --git   # your workspace: solutions, notes and progress
cd ~/cstudy-workspace
cstudy doctor --fix                    # checks the toolchains and sets up the projects
cstudy next                            # suggests a problem
cstudy start two-sum                   # writes the stub and the statement, opens your editor
cstudy test --watch                    # runs the tests on every save
cstudy done --rating ok                # finishes the attempt and schedules the review

Or practice in your browser, on the same workspace: cstudy serve --open.

The attempt view of cstudy serve: the file tree, the editor, a run's results and the statement

Documentation

The user docs ship with cstudy: cstudy docs lists them in the terminal, cstudy docs <topic> prints one, and the web UI's Docs view shows them with a search. They are the Markdown pages of user-docs/:

Page Covers
Getting started Install, your first workspace and problem, the main commands
Install the language toolchains uv and Python, Node.js and pnpm, a JDK, Go, Rust and Docker on macOS and Linux
Check your setup with cstudy doctor Every check, and how --fix sets up a workspace
Your workspace What the folder holds and version control
Upgrading cstudy Upgrading, what cstudy doctor --fix refreshes, and moving to a new machine
Work on a problem Start, test, hints, solutions, benchmarks and grades
Kinds of problems The tracks, the kinds, how each is checked, and the labels
Progressive levels and projects Problems that grow over levels, and cstudy submit
Service projects and the dev stack Apps in a Docker sandbox with mock servers, and cstudy dev
Your IDE and the debugger VS Code and IntelliJ IDEA files, and cstudy test --debug
Guides and learning paths Reading guides and following paths with cstudy learn
Plan your practice cstudy next, problem sets, mock interviews and statistics
Write your own problems cstudy new, checking a problem with cstudy verify, and making it ready
Practice in your browser cstudy serve: the views and the keyboard
The editor and code intelligence Live errors, hover documentation, go to definition and autocomplete
Settings and preferences config.toml, the preferences, backups and reset
The AI preview Your own keys, consent, the daily token cap, and AI review of rubric problems
Command reference Every command and its flags, and the exit codes
Troubleshooting What to do when something fails

To change cstudy itself: the developer docs (the PRD, architecture, specs and decision records), the CLI reference, the authoring guide for problems of your own, contributing, and the changelog.

Content catalog

All problem statements, tests and solutions are original (ADR 0004); LeetCode references only link to the well-known problem a statement is modeled on. The catalog holds 400 problems:

Track Problems Graded by Format
dsa 210 Tests, in all 6 languages Functions and data-structure designs across 24 patterns
practical 137 Tests, level by level where a problem has levels One class whose API grows over 4 levels, a business task with money and dates, a security or AI/LLM task in Python and TypeScript, a small service to extend, or a service project in Docker with mock servers and backing services
lld 8 Tests, then a design rubric Object-oriented design
concurrency 6 Stress tests against invariants Thread-safe classes, per-language models
debugging 23 Tests Buggy code to fix, including Go- and Rust-only bugs and JavaScript traps
system-design 10 Self-graded with a rubric Prompt, notes template, reference design
code-review 6 Self-graded with a rubric A change to review
behavioral none Not tracked Guidance for your own story bank

Track details: content. Every problem: catalog.

License

MIT, covering both the code and the original problem content.