Skip to main content

Easily define your own software project idea and then build entirely by just clicking a button.

Project description

JRI (i.e. Just Ralph It, a.k.a. Ralfealo)

Overview

Just Ralph It is a tool that aims to help you easily define your software project idea and then build entirely by just clicking a button. To know more about it, read the concept document.

Right now, it only features the Interviewer agent on a terminal user interface (TUI). It will help you define what you actually want to build, and take notes during the process. But you don't even have to think about that! Simply run jri and start sharing your thoughts, and the Interviewer will handle the rest. While you have your conversation, JRI manages the .jri/ directory inside your project.

So for now, you can hand the .jri/graph.json file to your favorite coding agent to help you implement it. Tip: ask it to write a plan first.

Getting started

Prerrequisites

  • Python >=3.13 or uv

Installation

pip install just-ralph-it
# or
uv tool install just-ralph-it

Authentication

Given that JRI is powered by LLMs, you need to provide an inference provider. You can authenticate with an API key from any OpenAI-compatible provider or reuse an existing ChatGPT subscription.

For both cases, the easiest way to authenticate is by creating a .env file at the root of your project or home directory. You can also export the variables in your shell or pass them as CLI arguments (see jri --help).

API key approach

# To use OpenAI as the provider, just set your OpenAI key here
JRI_LLM_API_KEY=...

# To use any OpenAI-compatible provider, provide its base URL too
JRI_LLM_PROVIDER=https://provider.example/v1
JRI_LLM_API_KEY=...

ChatGPT approach

To use a ChatGPT subscription, you need to have Codex installed and configure it to store credentials in a file:

# ~/.codex/config.toml
cli_auth_credentials_store = "file"

Then run:

codex login

Finally, configure the JRI provider:

# Configure JRI to reuse the Codex login
JRI_LLM_PROVIDER=openai-codex

Usage

# Create a new directory for your project or just move to an existing one
mkdir /path/to/your-project
cd /path/to/your-project

# Run the TUI
# This will ask for the necessary environment variables
# Once that's ready, it will also set the .jri/ directory up
jri

# See all available options
jri --help

# Visualize the notes graph
jri view

Setup recommendation

JRI is still under heavy development, so not all defaults have been set yet. However, as the developer, I have experienced pretty good and cheap results with the following configuration:

# .env
JRI_LLM_PROVIDER=https://openrouter.ai/api/v1
JRI_LLM_API_KEY=sk-or-v1-...
JRI_INTERVIEWER_MODEL=z-ai/glm-5.2
JRI_EXPLORER_MODEL=qwen/qwen3.5-9b
JRI_BRAVE_SEARCH_API_KEY=...

Upgrading

python -m pip install --upgrade just-ralph-it
# or
uv tool upgrade just-ralph-it

Be careful: until JRI reaches a stable version (>=1.0.0), anything could break from one version to another.

Uninstalling

# Uninstall JRI and its dependencies
pip uninstall just-ralph-it
# or
uv tool uninstall just-ralph-it

# Remove JRI from a repo
rm -fr /path/to/your-project/.jri

Contributing

Please refer to AGENTS.md.

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

just_ralph_it-0.1.5.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

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

just_ralph_it-0.1.5-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file just_ralph_it-0.1.5.tar.gz.

File metadata

  • Download URL: just_ralph_it-0.1.5.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for just_ralph_it-0.1.5.tar.gz
Algorithm Hash digest
SHA256 2ec3ceb96da2b883ccb1566cdf00f89eb81740b606bb9e6af172c69dfa6636f0
MD5 75b675ff1e164f26d2ce46d1ccb48228
BLAKE2b-256 9e2ca154c59c663e886d7b0688ecd2c15de79b52aca6f56affb50790ba01736c

See more details on using hashes here.

File details

Details for the file just_ralph_it-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: just_ralph_it-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for just_ralph_it-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3cba6b27f8caa8c5a1d10f12136e9a98a5c6dfb720734698a01c6e8deeb17c6c
MD5 4053525462344f458dd3e53bedaea195
BLAKE2b-256 b04c1fddac2712c4052b8c83c203820c6259ad23a69b8eb75cc8dd744eb3fb03

See more details on using hashes here.

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