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.0.tar.gz (2.7 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.0-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rplcopilot-0.1.0.tar.gz
  • Upload date:
  • Size: 2.7 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.0.tar.gz
Algorithm Hash digest
SHA256 7ab0ceb8c3f38755b40dd0f6eac00ed6cc3a9158ae24e710c990d6f3705db3c7
MD5 5ac02ad8173f040ee992fd752f293682
BLAKE2b-256 096477943751cc9f51776dd30683dc6d6bd38d5fc1c966d03c393926d376a6a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rplcopilot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bfea1536403477a067e9744f69504e165d0747e91dc64ae1929e45d317603d94
MD5 0b1d2a196869c38a8850e5745b017651
BLAKE2b-256 77519446242a5623471484201a70036e4c93fe9e894a516ff9702bd908c417fa

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