Skip to main content

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

Project description

Just Ralph It (a.k.a. Ralfealo)

Overview

Just Ralph It is a software system 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.

Feature Roadmap

  • Terminal UI
  • Interviewer
    • Exploration
    • Note taking
    • Topic-based context management
  • Project implementation
  • Remote execution
  • Web UI
    • Notes graph visualization
  • Hosted platform

Getting Started

0. Prerrequisites

  • Python >=3.13 or uv
  • API key from any OpenAI-compatible LLM inference provider or a ChatGPT subscription

1. Installation

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

2. Authentication

You can create 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).

Using an API key

# .env

# 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=...

Using a ChatGPT subscription

For this, 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 it as the provider:

# .env

JRI_LLM_PROVIDER=openai-codex

Optional: Brave Search

To support web search, provide a Brave Search API key:

# .env

JRI_BRAVE_SEARCH_API_KEY=...

3. Model selection

For now, there are no built-in model defaults, so you have to set them yourself:

# .env

# Recommended OpenAI preset
JRI_INTERVIEWER_MODEL=gpt-5.6-sol
JRI_EXPLORER_MODEL=gpt-5.6-terra

# Recommended cheap Chinese alternative (e.g. works with OpenRouter)
JRI_INTERVIEWER_MODEL=z-ai/glm-5.2
JRI_EXPLORER_MODEL=qwen/qwen3.5-9b

Note that there are default reasoning levels when available for the models:

  • Interviewer: high
  • Explorer: low

4. Usage

# Run the TUI and start chatting!
jri

# Visualize the notes graph
jri view

[!TIP] Given that JRI doesn't feature project implementation yet, you can hand the generated .jri/project.yaml file to your favorite coding agent as a starting point for implementation.

Upgrading

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

[!WARNING] 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.5.1.tar.gz (37.4 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.5.1-py3-none-any.whl (48.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.1.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.5.1.tar.gz
Algorithm Hash digest
SHA256 132f3f546d7e62024cf4e782405c4e52282f298409a7975e4c81192434e41dca
MD5 3f58185ceaf3f9b96cd17b6c5e07b40f
BLAKE2b-256 0076072de0e579044c241eaaef515376c229b7a7b9bd5b01faa1d1766ec1ce17

See more details on using hashes here.

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 48.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cff1c529fa99d47936f5d3e835fb82ea004d07e891d186a0d34326aceba34bc5
MD5 248defed1cc93dfcb8b61247b1a600e7
BLAKE2b-256 7a958cf87a43400a08912ac34741e736ed5d67178c1a07a09206b905f67f2851

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