0.1.0 • Published 8 months ago

@cretyz/lyra-ai v0.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
8 months ago

Lyra AI

A powerful terminal-based AI coding assistant powered by Claude 3.7 Sonnet.

Lyra AI Banner

Features

  • Conversational Coding: Chat with Lyra to build, debug, and improve your code
  • Fully Autonomous: Lyra executes commands, creates files, and runs applications without requiring your approval
  • Project Creation: Quickly scaffold new projects with popular templates
  • Smart Context Awareness: Lyra understands your current project and codebase
  • Tool Integration: Leverage terminal commands, file operations, and more through natural language
  • Custom Configuration: Set your API keys and preferences for a personalized experience
  • Automatic Application Launch: Runs dev servers in new terminal windows and opens browser windows to display applications

Installation

Prerequisites

  • Node.js (version 18 or higher)
  • An Anthropic API key for Claude access

Global Installation

npm install -g lyra-ai

Local Installation

git clone https://github.com/yourusername/lyra-ai.git
cd lyra-ai
npm install
npm run build
npm link

Setup

Before using Lyra, you need to configure your API key:

lyra config

This will prompt you to enter your Anthropic API key and other settings.

Usage

Starting a Conversation

lyra
# or
lyra start

This opens an interactive session with Lyra where you can ask coding questions, get help with errors, or collaborate on building new features.

Creating a New Project

lyra new my-project

Options:

  • -t, --template <template>: Project template (next, react, node, empty)
  • -p, --path <path>: Custom project path
  • -g, --git: Initialize git repository
  • -i, --install: Install dependencies

Example:

lyra new my-next-app -t next -g -i

Configuration

lyra config

This allows you to set or update:

  • Anthropic API Key
  • OpenAI API Key (for future integrations)
  • Log Level
  • Other settings

Example Prompts

Here are some example prompts you can use with Lyra:

  • "Create a simple Express API with user authentication"
  • "Build a React todo app with Tailwind CSS"
  • "Create a Next.js landing page with a contact form"
  • "Help me debug this React component" (then paste your code)
  • "Refactor this function to be more efficient" (then paste your code)
  • "Explain how promises work in JavaScript"
  • "Create a SQL query to find all users who signed up last month"

Testing Autonomous Features

You can test Lyra's autonomous features by running:

npm run test:autonomy

This will verify Lyra's ability to:

  • Create files and directories automatically
  • Open browser windows
  • Run commands in new terminal windows

Development

Building the Project

npm run build

Running in Development Mode

npm run dev

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

ISC License

Acknowledgements

  • Anthropic for the Claude AI model
  • All the open-source libraries that make Lyra possible