Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lmangani authored Dec 14, 2024
1 parent 6ccb9e9 commit 991b6e6
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<img src="https://github.com/user-attachments/assets/46a5c546-7e9b-42c7-87f4-bc8defe674e0" width=250 />

# DuckDB Copilot Extension

Experimental extension to run DuckDB as a Copilot Extension helper
Expand All @@ -12,6 +14,36 @@ npm run dev
open http://localhost:3000
```

## Development Environment
> Follow the `/docs` instructions to register your Copilot Extension
## Examples
### Basic Queries
```
@duckdb-copilot SELECT 1, 2, 3
```

### Table Persistence
```
@duckdb-copilot CREATE TABLE cities (
name VARCHAR,
country VARCHAR
);
```

```
@duckdb-copilot INSERT INTO cities
VALUES ('San Francisco', 'US'), ('Amsterdam','NL'), ('Bologna','IT');
```

```
@duckdb-copilot SELECT * FROM cities
```

To get up and running with your development environment, see the [Development Guide](./docs/DEVELOPMENT_SETUP.md).
### LLM SQL
```
@duckdb-copilot show all entries from cities
```

```
@duckdb-copilot show the duckdb version
```

0 comments on commit 991b6e6

Please sign in to comment.