Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eeue56/neuro-lingo
A language where you only implement comments
https://github.com/eeue56/neuro-lingo
Last synced: about 2 months ago
JSON representation
A language where you only implement comments
- Host: GitHub
- URL: https://github.com/eeue56/neuro-lingo
- Owner: eeue56
- License: bsd-3-clause
- Created: 2023-03-29T09:20:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T20:16:03.000Z (10 months ago)
- Last Synced: 2024-05-21T12:33:40.725Z (8 months ago)
- Language: TypeScript
- Size: 40 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# neuro-lingo
A language where you only implement comments and types, and let LLMs deal with the rest. LLMs don't always provide workable examples, so your comments need to really match what you're trying to implement. I [wrote about this on Derw's blog](https://derw.substack.com/p/introducing-neuro-lingo-a-llm-powered).
## Filenames
Neuro files end with .neuro
## Hello world
```typescript
function main() {
// Print "Hello World" to the console
}
```
when run produces
```
Hello World
```
## Adding two numbers
```typescript
function add(a: number, b: number): number {
// Add two numbers together
}
function main() {
// Print "Hello World" to the console
// Print the result of add(2, 3)
}
```
when run produces
```
Hello World
5
```
## Types
```typescript
type Person = {
name: string;
};
```
## Acknowledging a user
```typescript
type Person = {
name: string;
};
function greeting(user: Person): string {
// return and say hi to the user
}
function main() {
// greet a user with the name "Noah"
}
```
when run produces
```
Hi Noah, nice to meet you!
```
## Pinning a function
In order to use a previous implementation from the LLM, you can use the pinned keyword which will attempt to look up the previous implementation of that function. For consistent results I recommend git-adding the build files along with `pinned`.
```typescript
pinned function main() {
// greet a user with the name "Noah"
}
```
# Installing
Clone the repo and run ts-node src/cli.ts.
Create an .env file with your OPENAI_API_KEY.
You can also set OPENAI_GPT_MODEL to use an alternative model. The default is gpt-3.5-turbo.
## Using the CLI
```bash
--file string: The filename to compile
--quiet : Avoid writing non-esstential output to terminal
-h, --help : This help text
--run : Run the file after generating it
```
# Notes
You can modify the prompts in [src/generate.ts](src/generator.ts) to your liking - if you find a better one, please open a pull request.
neuro-lingo is absolutely not recommened for use in productiong. It is a thought exercise which just so happens to have a functioning compiler.