ngcli 0.1.1
GraphScope CLI shell for NeuG
Requires Python: >=3.8
Keywords: Graph, Embedded, Graph Database, Command Line Interface, CLI

# Neug CLI Tool

The `Neug` CLI tool provides an interactive shell for querying and managing NeuG database. It supports both local and remote database connections, Cypher query execution, and result formatting.

## Installation
You can install `ngcli` using pip:

```bash
pip install ngcli
```

Alternatively, to install from source:

```bash
git clone https://github.com/GraphScope/neug.git
cd neug/tools/shell
pip install .
```

After installation, you can verify that `ngcli` is installed correctly by running:

```bash
ngcli --version
```

This should display:

```
ngcli, version 0.1.0
```

## Usage

### Overview

The `ngcli` tool allows you to interact with the Neug database in both local and remote modes. To view the basic usage, run:

```bash
ngcli --help
```

This displays:

```
Usage: ngcli [OPTIONS] COMMAND [ARGS]...

    Neug CLI Tool.

Options:
    --version  Show the version and exit.
    --help     Show this message and exit.

Commands:
    connect  Connect to a remote database.
    open     Open a local database.
```

### Start the Shell by Opening a Local Database

To open a local Neug database, specify the database path when starting the CLI. By default, the database is opened in read-write mode, and changes are persisted to disk when the shell exits. If the specified directory does not exist, it will be created automatically.

To open the database in read-only mode, use the `--readonly` or `-r` option.

```bash
ngcli open <path-to-db> [--readonly | -r]
```

- `--readonly`, `-r`: Open the database in read-only mode.

### Start the Shell by Connecting to a Remote Database

To connect to a remote Neug server, specify the server URI when starting the CLI. You can optionally provide a username, password, and query timeout. Note that remote connection support is under development.

```bash
ngcli connect <host:port> [--user <username> | -u <username>] [--password <password> | -p <password>] [--timeout <seconds>]
```

- `--user`, `-u`: Username for authentication.
- `--password`, `-p`: Password for authentication.
- `--timeout`: Connection timeout in seconds (default: 300).

### Interactive Shell Commands

Once you start the shell, you can execute Cypher queries and use various interactive commands:

- Enter Cypher queries directly to execute them.
- Use `:help` to display this help message.
- Use `:quit` or press Ctrl+C to leave the shell.
- Use `:max_rows <number>` to set the maximum number of rows to display for query results.
- Multi-line commands are supported. Use ';' at the end to execute.
- Command history is supported; use the up/down arrow keys to navigate previous commands.

## Example

```bash
ngcli open /tmp/modern_graph
```

This will open embedded Neug database at `/tmp/modern_graph` in `rw` mode by default, and start the shell. Then you can execute Cypher queries directly:

```
Welcome to the Neug shell. Type :help for usage hints.

neug > MATCH (n:person) RETURN n;
+-------------------------------------------------------+
| n                                                     |
+=======================================================+
| {_ID: 0, _LABEL: person, id: 1, name: marko, age: 29} |
+-------------------------------------------------------+
| {_ID: 1, _LABEL: person, id: 2, name: vadas, age: 27} |
+-------------------------------------------------------+
| {_ID: 2, _LABEL: person, id: 4, name: josh, age: 32}  |
+-------------------------------------------------------+
| {_ID: 3, _LABEL: person, id: 6, name: peter, age: 35} |
+-------------------------------------------------------+
```