Skip to main content

Think through a software project idea, then build it with one click.

Project description

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

Overview

Think through a software project idea, then build it with one click. 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.4.tar.gz (37.6 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.4-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.4.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.4.tar.gz
Algorithm Hash digest
SHA256 5fa4a25c0bc6516bf3ac60f8c1b58b4d0618ddf897f2758be60a628198a26921
MD5 84a4b50071cf930951b2e3a38e1f2008
BLAKE2b-256 9ca496a3777e9b29c1b953cbf6c542effc70062688fc645897797267679e7c76

See more details on using hashes here.

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 07b269a47e86d597e089c2537be7d3b3f519d6cd1218d66c9894373db1fcdd6f
MD5 6686bd59aea9500e91eb58a2bcc8b04f
BLAKE2b-256 63024caa949f4ea087d8e39db472cd3d05db1471f836a8c7d97e4f3dbd517884

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