Skip to main content

AI-powered lab assistant CLI

Project description

pip install -e . rpl init rpl log "Experiment X"

🚀 Ripple Copilot CLI (rpl)

AI-powered command-line lab assistant for researchers.
Log experiments, upload files, and build a searchable knowledge base using natural language.


📦 Installation

git clone https://github.com/your-org/rpl-cli.git
cd rpl-cli
chmod +x rpl.py
ln -s $(pwd)/rpl.py /usr/local/bin/rpl   # optional: system-wide install

Now you can use rpl globally from the terminal:

rpl init ...

🧪 Commands

🔹 rpl init <project>

Initialize a new RPL project in the current directory. Creates a .rpl/ folder.

rpl init quantum --description "Quantum film experiments"

🔹 rpl log

Log an experiment under the current project.

rpl log --title "Day 1" --notes "Tested sapphire substrate." --tags "GHz,permittivity"

🔹 rpl upload <folder>

Upload and index all files in a folder into your knowledge base.

rpl upload data/experiments
rpl upload "/Users/jorgehernancardenas/Downloads/PaperReview" 

🔹 rpl upload <file>

Upload and embed a single file.

rpl upload results_day1.pdf

🔹 rpl query "<question>"

Ask a natural language question against the project’s indexed documents.

rpl query "What did we learn about sapphire at 10 GHz?"

🔹 rpl list

List all available .rpl projects found in subdirectories.

rpl list

🔹 rpl switch <project>

Switch the active project context.

rpl switch metasurfaces

🔹 rpl current

Show the currently active project.

rpl current

🔹 rpl push

Simulates syncing with a remote API. Calculates and reports the size of files to be synced.

rpl push

🗃 Project Structure

Each initialized project will follow this structure:

your-lab-project/
└── .rpl/
    ├── config.json               # Points to current project
    └── projects/
        └── <project-name>/
            ├── metadata.json
            ├── logs/
            ├── uploads/
            └── faiss_index/

📬 Coming Soon

  • rpl pull to fetch a project from the remote backend
  • rpl auth for login and team access
  • Web UI to view, search, and visualize experiments
  • Multi-user project collaboration

👩‍🔬 Built for Lab Researchers

Ripple Copilot is designed for:

  • Materials science labs
  • Biotech and nanotech researchers
  • Anyone running complex experiments with hard-to-track results

🧠 Credits

Crafted with ❤️ by the Ripple Copilot team
Feel free to fork, extend, or contribute!

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

rplcopilot-0.1.5.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

rplcopilot-0.1.5-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rplcopilot-0.1.5.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for rplcopilot-0.1.5.tar.gz
Algorithm Hash digest
SHA256 e2f77e581fee5f8e6d8b8adf9a8e0a1f3592b636845ad95e1ad49438a524ec71
MD5 196d6ae06bee1de8df388de10503dc30
BLAKE2b-256 0149d9343cd9b33fcdf61592ae591b21630f3f972d03ec4f08ff0e60cf6f0117

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rplcopilot-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for rplcopilot-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 67748548576e9b74211f9cd06bd0b0a3608702f49b565c452a91717d9e3cad83
MD5 0e9d320687a6b16810b26a0d7edc0841
BLAKE2b-256 a730626fe21df69050172335f6c10fbdaa4a1531cbe027e8a3c593436bb8d64a

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