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 this project, 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.5.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.5-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.5.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.5.tar.gz
Algorithm Hash digest
SHA256 44735c1a717db6e434b8298f15e5871becbdd6eb763a7bdf3dc1e0e1ed901c0a
MD5 ff6ab18352edb9516db207247644ef57
BLAKE2b-256 6b95caa6c022d39911738fb823ed76af62845191bec656861a3c4f454547cf39

See more details on using hashes here.

File details

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

File metadata

  • Download URL: just_ralph_it-0.5.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b938bd828bc0213d90a79178ba3566fb77cfe50ba39b1768e04404bb0b8c8ab9
MD5 64cb952b2ec581c583f70007dee4b9af
BLAKE2b-256 305c34ea4d8e0f34754302b7f2930a72ad6a4d8164e138e31547a5f2b7efae3c

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