CLI tool for the Luca assistant
Project description
LUCA CLI Client
Overview
The LUCA CLI Client is a command-line interface for your LUCA AI Copilot for Research.
It allows you to interact with your dedicated AI research assistant that lives in your terminal. This is a non-intrusive user experience, that means you still have complete control over your terminal. But your AI assistant is always a command away.
Capabilities
We have designed the system to be able to:
- Retrieve and search relevant research papers from ArXiv.
- Retrieve experiments logged in a Weights & Biases project.
- Generate and execute Python and bash commands.
- Create presentations, reports, and analyze data.
With these capabilities, you can use the assistant to:
- Generate reports that theorize and summarize your research experiments.
- Generate a project plan to tackle a new research problem.
- Brainstorm, ideate, and generate new hypotheses based on your current experiments.
- Analyze experiment data and create visualizations.
Pre-installation
Before installing the LUCA CLI, please make sure you have:
- Created an account on the LUCA platform
- Signed up for a research agent (this provisions your dedicated VM)
- Created an API key from your dashboard
Installation
pip install luca-cli
Setup
Quick Setup (Interactive)
Run the interactive setup command to configure your API key:
luca setup
This will guide you through:
- Getting your API key from the dashboard
- Setting up your environment variables
- Testing your connection
Manual Setup
Alternatively, you can manually set up your environment:
- Get your API key from your dashboard
- Set the environment variable:
export LUCA_API_KEY="luca_your_api_key_here"
- Add to your shell profile (optional but recommended):
echo 'export LUCA_API_KEY="luca_your_api_key_here"' >> ~/.bashrc # or for zsh: echo 'export LUCA_API_KEY="luca_your_api_key_here"' >> ~/.zshrc
Verify Setup
Test your authentication:
luca auth
This will verify your API key and show your agent status.
Usage
Help and Commands
luca --help
View all available commands and configuration options.
Initialize Your Agent
After setting up your API key, initialize your research agent:
luca init
This will initialize your dedicated research assistant and create a knowledge base in $ROOT/.luca/kb.txt.
This knowledge base will be updated with new information as you use the assistant.
Start Research
You can start interacting with your research assistant by typing your prompt:
luca "Research papers on reinforcement learning"
luca "Analyze the experiment data in my current directory"
luca "Create a summary of recent advances in transformer architectures"
Advanced Usage with W&B Integration
If you are using Weights & Biases to log your experiments, you can set your W&B credentials and re-initialize:
export WANDB_API_KEY="your-wandb-api-key"
export WANDB_ENTITY="your-wandb-entity"
luca init
This will update your assistant to access your W&B experiments. You can then create powerful reports:
luca "Export a PowerPoint report of all experiments in my wandb project <your-project-name>"
luca "Compare the performance of my last 5 experiments and suggest improvements"
File Management
Any file your assistant creates will be synced to your local machine and saved in $ROOT/.luca/artifacts/:
luca artifacts # List all created files
Sync Knowledge Base
Keep your local knowledge base up to date:
luca sync
Provide Feedback
Help us improve by sharing your experience:
luca feedback "I love how the assistant helps with data analysis!"
Available Commands
| Command | Description |
|---|---|
luca setup |
Interactive API key setup |
luca auth |
Check authentication status |
luca init |
Initialize your research agent |
luca sync |
Sync knowledge base from agent |
luca artifacts |
List all available artifacts |
luca feedback <message> |
Send feedback to our team |
luca "<prompt>" |
Ask your research assistant anything |
Configuration
Environment Variables
| Variable | Description | Required |
|---|---|---|
LUCA_API_KEY |
Your API key from the dashboard | Yes |
LUCA_GATEWAY_URL |
Gateway URL (default: https://www.myluca.ai/api/gateway) | No |
WANDB_API_KEY |
Your Weights & Biases API key | Optional |
WANDB_ENTITY |
Your Weights & Biases entity name | Optional |
Security
- Your API key is used to authenticate with your dedicated research agent
- All communication is encrypted via HTTPS
- Your research agent runs on a dedicated VM that only you have access to
- API keys can be managed and revoked from your dashboard
Troubleshooting
Authentication Issues
❌ Error: LUCA_API_KEY environment variable not set.
Solution: Run luca setup or manually set your API key.
Agent Not Ready
❌ Service Unavailable: Your agent is not ready
Solution: Your VM is still being provisioned. Wait 2-5 minutes and try again.
Connection Issues
❌ Connection error. Please check your internet connection.
Solution: Check your internet connection and try again.
For more help, visit your dashboard or contact support.
What's New
v2.0.0 - API Key Authentication
- 🔐 Secure API Key Authentication: No more VM IP addresses to manage
- 🚀 Improved Setup: Interactive setup with
luca setup - 📊 Better Status Checking: Use
luca authto check your agent status - 🛡️ Enhanced Security: All requests routed through secure gateway
- ✨ Better Error Messages: Clear, actionable error messages
- 🎯 Simplified Configuration: Just set your API key and go
Roadmap
We plan to significantly expand the capabilities of your research assistant with each release:
- 📚 Enhanced Literature Review: Better paper discovery and summarization
- 🧪 Experiment Management: Advanced experiment tracking and analysis
- 📈 Data Visualization: Automatic chart and graph generation
- 🤝 Team Collaboration: Share insights and results with your team
- 🔧 Custom Tools: Integration with your favorite research tools
Feedback
Your feedback helps us build better tools for researchers. Share your thoughts:
luca feedback "Your message here"
Or reach out through our dashboard.
Happy researching! 🚀
The LUCA Team
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file luca_cli-0.1.5.tar.gz.
File metadata
- Download URL: luca_cli-0.1.5.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
befd01a691cad58e53bdcc14204217251b02c2763b12f42f5d8f0dfcb0269c43
|
|
| MD5 |
52a2b7d37af9d7d8dca7b4f8d2690610
|
|
| BLAKE2b-256 |
4ee7bec3415c20447d01feef2eb2ba0a38272b330c6ff6e50ba4042e4920225b
|
File details
Details for the file luca_cli-0.1.5-py3-none-any.whl.
File metadata
- Download URL: luca_cli-0.1.5-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
349bee934c4e6af19916601e731790ffb433a002bc9d9d687d65c54eef8383df
|
|
| MD5 |
de293e5dc2ddbdfc887131aa48336659
|
|
| BLAKE2b-256 |
69ad2a1af7345010917cb8502b00ead65e2110c879185c152bd3fdabbb15b097
|