A simple typescript CLI tool to translate natural human language to SQL with Ollama (Mistral 7B) model
This project provides a foundation for creating a command-line interface (CLI) application that translates natural language queries into SQL. It uses TypeScript and several popular libraries to offer a robust starting point for CLI development.
- Natural language to SQL translation
- Command-line interface using Commander.js
- Spinner animation for visual feedback during translation
- SQL formatting for improved readability
- Error handling and informative error messages
-
Clone the repository:
git clone https://github.com/asmirbe/ollama-cli-human-to-sql.git cd typescript-cli-starter -
Install dependencies:
npm install
To run the application in development mode:
npm run dev -- <query> [options]
To build and run the application:
npm run build
node ./dist/cli.js <query> [options]
-s, --schema <schema>: Provide a table schema for context-V, --version: Output the version number-h, --help: Display help for command
npm run dev -- "Show me all users who joined last month"
npm run dev: Run the application in development modenpm run clean: Remove build artifactsnpm run build: Build the applicationnpm run bundle: Build and package the application for distribution
- commander: For building the command-line interface
- isomorphic-unfetch: For making HTTP requests
- sql-formatter: For formatting SQL queries
- pkg: For packaging the application
- rimraf: For cross-platform directory removal
- ts-node: For running TypeScript files directly
This project is licensed under the MIT License.
Contributions are welcome! Please feel free to submit a Pull Request.
This project uses Ollama API for natural language to SQL translation. Make sure you have Ollama running locally on http://localhost:11434 with the mistral model available.