Skip to content

Commit

Permalink
Add command options to surreal version (#824)
Browse files Browse the repository at this point in the history
Co-authored-by: Obinna Ekwuno <[email protected]>
  • Loading branch information
Dhghomon and Ekwuno authored Sep 5, 2024
1 parent ede9efd commit 76c3a93
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions doc-surrealdb_versioned_docs/version-latest/cli/version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,28 @@ The version command outputs the current version of the installed command-line to
__BEFORE YOU START :__ Make sure you’ve [installed SurrealDB](/docs/surrealdb/installation) — it should only take a second!
:::

## Command options

<table>
<thead>
<tr>
<th colspan="2">Arguments</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="2">
<code>-e</code> / <code>--endpoint</code>
<l className='grey'>OPTIONAL</l>
</td>
<td>
Remote database server url to connect to [aliases: conn]
</td>
</tr>
</tbody>
</table>

## Example usage

To display the current command-line tool version, along with the platform and architecture, in a terminal run the surreal version command without any further arguments.
Expand All @@ -34,3 +56,22 @@ surreal -V
```bash
surreal --version
```

## Command help

To see the help information and usage instructions, in a terminal run the `surreal version --help` command without any further arguments. This command gives general information on the arguments, inputs, and additional options for the `version` command.

```bash
surreal version --help
```
The output of the above command :

```
Output the command-line tool and remote server version information
Usage: surreal version [OPTIONS]
Options:
-e, --endpoint <ENDPOINT> Remote database server url to connect to [aliases: conn]
-h, --help Print help
```

0 comments on commit 76c3a93

Please sign in to comment.