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.3.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.3-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rplcopilot-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 94bded793047bef6dfd46d93da4c90d8ebd226d4b4cbaef596375f8be20239f8
MD5 61f0028a07b88075092abff14a92792e
BLAKE2b-256 823bfcd512f94d4204744f0bc9dfa7a7c758cb8743870e4ce01b33524d115a34

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rplcopilot-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 69f859c5b9f9e891e2b7dad7c19f7d580c8dd0ee302d9448be115c7b98c53be0
MD5 c2615f10e403e7b1f8c76a34545bcc6b
BLAKE2b-256 1d5e6908292c39e74c1f40d1697401d56914deb7276c3d122e0df5819dad91bf

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