nlsql-coder
nlsql-coder is NLSQL's coding agent, a privacy & security focused, tool-driven, workspace-aware AI system designed to help with both personal and client-based development tasks.
Features
- User-friendly command line interface.
- Wide array of LLM/provider support acorss many cloud ecosystems, including locally hosted model support (local support not yet implemented).
- Primary privacy & security focus.
- Full MCP support (stdio, sse and streamable-http supported).
How it Works
The agent operates using a ReAct-style loop. A user submits a prompt, and the agent processes it by reasoning about the task, performing actions using available tools, and evaluating the results.
If the outcome is insufficient or incomplete, the agent continues this cycle, refining its approach and taking further actions until it can produce a final response.
Usage
To get started, you'll need an NLSQL API key, simply sign up to NLSQL to obtain your free API key.
You'll also need your own LLM instance from one of the following providers:
- AWS Bedrock
- Azure AI
- Google Cloud (GCP)
- AWS SageMaker (Not yet implemented)
- Or select a locally hosted Hugging Face model. (Not yet implemented)
nlsql-coder is available for download via PyPI, follow the steps below to get it running on your system:
- run
pip install nlsql-coder - use the command
nlsql-coder initto run from your CWD.
for other options or extended usage, see Arguments section below.
Arguments
Use the init command to start the application from the current working directory.
| Short | Long | Description | Defaults to |
|---|---|---|---|
-w |
--workspace |
The root directory of the project you want to work on. | . |
-u |
--usage |
Displays usage data after each conversation turn (input & output tokens) | False |
Modes
The agent has three modes:
- Plan mode
- Code (manual) mode
- Auto mode
Use Shift+Tab to switch between the modes.
Plan mode means the agent has read-only access and is configured to plan a task or project with the user. When a sufficent plan has been created the user can choose to proceed with the plan in either Auto or Manual mode, give feedback and amend the plan, or discard the plan.
Manual mode means the user will have to actively confirm tool calls.
Auto mode means only certain tool calls will need to be confirmed by the user (e.g. delete, git commands...)
Tools
By default the agent has access to several tools:
- read_file
- edit_file
- write_file
- delete (for files and directories in the CWD)
- execute_bash_command (can execute bash command on an internally supplied whitelist only)
- search_the_web (allows for both search engine results and URL content extraction)
The agent also has MCP support (add MCP servers via mcp.json)
Feedback and Issues
To provide feedback or report an issue contact us at https://nlsql.com/contacts or email info@nlsql.com
Please note: nlsql-coder is under active development
Metadata
Release files for nlsql-coder 0.1.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| nlsql_coder-0.1.9.tar.gz | 58.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nlsql_coder-0.1.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 126.0 kB
Release files / nlsql_coder-0.1.9.tar.gz
| Download URL | nlsql_coder-0.1.9.tar.gz |
|---|---|
| Size | 58.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f8baea476f1b10cd32eeac35af5cf2df450ab23872664349943cede48c732d4
|
|
BLAKE2b-256 checksum How to use checksums |
c057232b32595d1a59e61f00adc17d0144f3f3ad0b58f1706df929a81a4200c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Release files / nlsql_coder-0.1.9-py3-none-any.whl
| Download URL | nlsql_coder-0.1.9-py3-none-any.whl |
|---|---|
| Size | 67.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e93391fc6d902af5ea5650a0a1ae0164bd260a87cee41c358d62a39be9c19601
|
|
BLAKE2b-256 checksum How to use checksums |
b6914e6e0e1d697bd4cf5810c8f57bb9f4fff9c908a1eec83454d0ec6aa35fca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Security for nlsql-coder 0.1.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.