Skip to content

Commit 84256e7

Browse files
committed
increased ai code assistant friendliness
1 parent 79e1b47 commit 84256e7

File tree

6 files changed

+281
-351
lines changed

6 files changed

+281
-351
lines changed

README.md

Lines changed: 54 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@
99
[![GitHub issues](https://img.shields.io/github/issues/localcloud-sh/localcloud)](https://github.com/localcloud-sh/localcloud/issues)
1010
[![GitHub stars](https://img.shields.io/github/stars/localcloud-sh/localcloud?style=social)](https://github.com/localcloud-sh/localcloud/stargazers)
1111
[![Platform Support](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)](README.md#installation)
12+
[![AI Assistant Ready](https://img.shields.io/badge/AI%20Assistant-Ready-9cf?logo=openai)](README.md#🤖-ai-assistant-integration-guide)
1213
[![Test Suite](https://img.shields.io/badge/Tests-8%20Components-green)](test-components/README.md)
1314

1415
</div>
1516

16-
**From idea to running code in minutes, not weeks.** LocalCloud delivers production databases, AI models, and storage instantly. No DevOps, no cloud bills, no infrastructure drama.
17+
**From idea to running code in minutes, not weeks.** LocalCloud delivers developer-friendly PostgreSQL, MongoDB, vector databases, AI models, Redis cache, job queues, and S3-like storage instantly. No DevOps, no cloud bills, no infrastructure drama.
1718

1819
## 🚀 **Why Developers Choose LocalCloud**
1920

@@ -25,93 +26,60 @@
2526
- 🤝 **Remote Teams** - Share running environments with frontend developers without deployment hassles
2627
- 🧪 **Testing Pipelines** - Integrate AI and databases in CI without external dependencies
2728
- 🔧 **Prototype Speed** - Spin up full-stack environments faster than booting a VM
28-
29-
> **New in latest version**: Simplified setup! Now just use `lc setup` to create and configure projects in one command.
29+
- 🤖 **AI Assistant Users** - Works seamlessly with Claude Code, Cursor, Gemini CLI for AI-powered development
3030

3131
## 🚦 Quick Start
3232

3333
### Installation
3434

35-
#### macOS
35+
**Quick Install (macOS & Linux):**
36+
```bash
37+
curl -fsSL https://localcloud.sh/install | bash
38+
```
3639

37-
**Homebrew (Recommended)**:
40+
**Or via Homebrew:**
3841
```bash
3942
brew install localcloud-sh/tap/localcloud
4043
```
4144

42-
**Manual Installation**:
45+
<details>
46+
<summary>Manual Installation & Windows</summary>
4347

44-
Apple Silicon:
48+
**macOS Manual:**
4549
```bash
50+
# Apple Silicon
4651
curl -L https://localcloud.sh/releases/darwin-arm64 | tar xz
4752
sudo install -m 755 localcloud-darwin-arm64 /usr/local/bin/localcloud
48-
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
49-
```
5053

51-
Intel:
52-
```bash
54+
# Intel
5355
curl -L https://localcloud.sh/releases/darwin-amd64 | tar xz
5456
sudo install -m 755 localcloud-darwin-amd64 /usr/local/bin/localcloud
55-
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
56-
```
57-
58-
#### Linux
59-
60-
**Homebrew (if installed)**:
61-
```bash
62-
brew install localcloud-sh/tap/localcloud
6357
```
6458

65-
**Manual Installation**:
66-
67-
<details>
68-
<summary>Show installation commands</summary>
69-
70-
AMD64:
59+
**Linux Manual:**
7160
```bash
61+
# AMD64
7262
curl -L https://localcloud.sh/releases/linux-amd64 | tar xz
7363
sudo install -m 755 localcloud-linux-amd64 /usr/local/bin/localcloud
74-
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
75-
```
7664

77-
ARM64:
78-
```bash
65+
# ARM64
7966
curl -L https://localcloud.sh/releases/linux-arm64 | tar xz
8067
sudo install -m 755 localcloud-linux-arm64 /usr/local/bin/localcloud
81-
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
8268
```
83-
</details>
84-
85-
#### Windows (Under Testing)
86-
<details>
87-
<summary>Show Windows installation (experimental)</summary>
8869

89-
1. Download the latest release from [GitHub Releases](https://github.com/localcloud-sh/localcloud/releases)
90-
2. Extract `localcloud-windows-amd64.zip`
91-
3. Add the extracted folder to your system PATH
92-
4. Restart your terminal
93-
5. Use `localcloud` or `lc` commands
70+
**Windows (Experimental):**
71+
1. Download from [GitHub Releases](https://github.com/localcloud-sh/localcloud/releases)
72+
2. Extract and add to PATH
73+
3. Use WSL2 for best compatibility
9474

95-
**Note**: Windows support is experimental. WSL2 is recommended for better compatibility.
9675
</details>
9776

98-
### Quick Install Script
99-
100-
For macOS and Linux, you can also use our install script:
101-
102-
```bash
103-
curl -fsSL https://localcloud.sh/install | bash
104-
```
105-
106-
This script will:
107-
- Detect your OS and architecture
108-
- Use Homebrew if available (macOS)
109-
- Download the appropriate binary
110-
- Install LocalCloud and create the `lc` alias
11177
### Getting Started
11278

79+
#### 👨‍💻 Interactive Setup
80+
11381
```bash
114-
# Setup in current directory
82+
# Setup your project with an interactive wizard
11583
lc setup
11684
```
11785

@@ -133,14 +101,28 @@ You'll see an interactive wizard:
133101
◯ [Infrastructure] Object Storage (MinIO) - S3-compatible object storage for files and media
134102
```
135103

104+
Then start your services:
136105
```bash
137-
# Start all selected services
138106
lc start
139107

140-
# Your AI services are now running!
108+
# Your infrastructure is now running!
141109
# Check status: lc status
142110
```
143111

112+
#### 🤖 Non-Interactive Setup (AI Assistants)
113+
114+
AI assistants can set up projects with simple commands:
115+
116+
```bash
117+
# Quick presets for common stacks
118+
lc setup my-ai-app --preset=ai-dev --yes # AI + Database + Vector search
119+
lc setup my-app --preset=full-stack --yes # Everything included
120+
lc setup blog --preset=minimal --yes # Just AI models
121+
122+
# Or specify exact components
123+
lc setup my-app --components=llm,database,storage --models=llama3.2:3b --yes
124+
```
125+
144126
> **Note**: `lc` is the short alias for `localcloud` - use whichever you prefer!
145127
146128
## ✨ Key Features
@@ -153,13 +135,23 @@ lc start
153135
- **🔧 Developer Friendly**: Simple CLI, clear errors, extensible architecture
154136
- **🐳 Docker-Based**: Consistent environment across all platforms
155137
- **🌐 Mobile Ready**: Built-in tunnel support for demos anywhere
138+
- **📤 Export Tools**: One-command migration to any cloud provider
139+
- **🤖 AI Assistant Ready**: Non-interactive setup perfect for Claude Code, Cursor, Gemini CLI
156140

157141
## 🎯 Vision
158142

159143
**Make production infrastructure as simple as running a local web server.**
160144

161145
LocalCloud eliminates the complexity and cost of infrastructure setup by providing a complete, local-first development environment. No cloud bills, no data privacy concerns, no complex configurations - just pure development productivity.
162146

147+
## 🤖 AI Assistant Integration
148+
149+
**For AI coding assistants:** Share this repository link to give your AI assistant complete context:
150+
151+
> *"I'm using LocalCloud for local AI development. Please review this repository to understand its capabilities: https://github.com/localcloud-sh/localcloud"*
152+
153+
Your AI assistant will automatically understand all commands and help you build applications using LocalCloud's non-interactive setup options.
154+
163155
## 💡 Perfect For These Scenarios
164156

165157
### 🏢 **Enterprise POCs Without The Red Tape**
@@ -191,6 +183,11 @@ No API rate limits. No usage caps. No waiting for credits. Just pure development
191183
**Code Review Bot**: Build a team-specific code reviewer without sending code to external APIs.
192184
**Meeting Transcription System**: Record, transcribe, and summarize meetings - all on company hardware.
193185

186+
### 🤖 **AI Assistant Development in One Coffee Sip**
187+
**"Hey Claude, build me a chatbot backend"** → Your AI assistant runs `lc setup my-chatbot --preset=ai-dev --yes` and in 60 seconds you have PostgreSQL, vector search, AI models, and Redis running locally. Complete with database schema, API endpoints, and a working chat interface. By the time you finish your coffee, you're making API calls to your fully functional backend.
188+
189+
No cloud signup. No credit card. No infrastructure drama. Just pure AI-assisted development velocity.
190+
194191
## 📚 Available Templates
195192

196193
During `lc setup`, you can choose from pre-configured templates or customize your own service selection:

0 commit comments

Comments
 (0)