Metadata-Version: 2.4
Name: nl2sql-cli
Version: 0.10.0
Summary: The nl2sql command line: index, ask, review, evaluate and serve a database you query in English
License-Expression: MIT
Project-URL: Homepage, https://github.com/nadeem4/nl2sql
Project-URL: Documentation, https://nadeem4.github.io/nl2sql/
Project-URL: Source, https://github.com/nadeem4/nl2sql
Project-URL: Issues, https://github.com/nadeem4/nl2sql/issues
Project-URL: Demo, https://nl2sql.codewithnk.com
Keywords: nl2sql,text-to-sql,natural language,sql,llm,cli,terminal
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: nl2sql-engine~=0.10.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.9.0
Requires-Dist: typing_extensions>=4.0
Requires-Dist: textual>=0.80
Provides-Extra: web
Requires-Dist: nl2sql-api~=0.10.0; extra == "web"

# nl2sql-cli

The `nl2sql` command for [NL2SQL](https://github.com/nadeem4/nl2sql): set up a project, index its schema, ask questions, run evaluations and review what the engine learned. It is a thin layer over the public `nl2sql` facade of `nl2sql-engine`.

```bash
pip install "nl2sql-cli[web]"   # the command and the web app
nl2sql demo                     # a demo project in ./nl2sql-demo, served at http://127.0.0.1:8765/
```

Without the `web` extra, `pip install nl2sql-cli` gives the command alone (every command except `nl2sql demo`, which starts the web app, `nl2sql-api`, as a child process).

The distribution depends on `nl2sql-engine` and `textual` only. It is imported as `nl2sql_cli` and installs one console script, `nl2sql`. The engine and the web app never import it.

Documentation: <https://nl2sql.codewithnk.com> and the repository's `docs/`.
