Skip to main content

NLSQL’s AI coding agent. CLI tool for interacting with existing codebases and building new applications from scratch.

Project description

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:

  1. run pip install nlsql-coder
  2. use the command nlsql-coder init to 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 please email info@nlsql.com

Please note: nlsql-coder is under active development

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nlsql_coder-0.1.1.tar.gz (39.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nlsql_coder-0.1.1-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file nlsql_coder-0.1.1.tar.gz.

File metadata

  • Download URL: nlsql_coder-0.1.1.tar.gz
  • Upload date:
  • Size: 39.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for nlsql_coder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6c263a8a0b01534b226653fbd147637e4ee9f28d93ac9e3dbb5b77de11565a8c
MD5 61836feac5ecb887311f203345aab6c0
BLAKE2b-256 999ebe720ab036b03a3b56b0c80f4f61631194b32645e4b344d4d56fbbf47a59

See more details on using hashes here.

File details

Details for the file nlsql_coder-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nlsql_coder-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for nlsql_coder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 156cc4578b2b5d139b10a25f67bdd0fcf3ead1efef954a7d183d230f5724e373
MD5 2cbe763cc1574527939a0abedc3d2dd3
BLAKE2b-256 b46d76cd786f7a4a62f1eb8fddf75b8a940a9fc3243808f67f3ee0c8c8aca745

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page