zhongwei/gh-oceanbase-ecology-plugins-seekdb-claudecode-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Zhongwei Li
2025-11-30 08:44:54 +08:00
commit eb309b7b59
133 changed files with 21979 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
skills/seekdb-docs/official-docs/400.guides/1000.obshell/300.obshell-clients/100.agent-commands.md Normal file
View File

@@ -0,0 +1,92 @@
---
slug: /agent-commands
---
# obshell agent commands
This topic describes the obshell agent commands, which are used to manage obshell. You can use the `-h`/`--help` option in a command to view the help information of the command. For example, `obshell agent start -h --seekdb` is used to view the help information of the `start` command for seekdb. `--seekdb` indicates that the help information of the `start` command for seekdb is to be viewed.
## obshell agent start
Use this command to start obshell.
```shell
obshell agent start [-P] [--password] [--seekdb] [--base-dir] [-6]
# example
obshell agent start -P 2886 --base-dir /var/lib/oceanbase
```
The following table describes the options.
| Option | Required | Data type | Default value | Description |
| --- | --- | --- | --- | --- |
| -P/--port | No | int | 2886 | The port number to which the obshell is bound. |
| --password | No | string | N/A | This option is used only for taking over a seekdb instance. When you take over a seekdb instance, you must use this option to specify the password of the root user of the seekdb instance. You can also specify the root user password by using the `OB_ROOT_PASSWORD` environment variable. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. If you specify `--base-dir`, you can omit `--seekdb`. |
| --base-dir | No | string | N/A | The working directory of obshell. It must be consistent with the working directory of the corresponding seekdb instance. If you do not specify this option, the default value is the current directory. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
## obshell agent stop
Use this command to stop obshell.
```shell
obshell agent stop [--port] [--seekdb] [-6]
# example
obshell agent stop --seekdb --port 2886
```
The following table describes the options.
| Option | Required | Data type | Default value | Description |
| --- | --- | --- | --- | --- |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can specify the obshell port by using the `OBSHELL_PORT_FOR_SEEKDB` environment variable. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
## obshell agent restart
Use this command to restart obshell.
```shell
obshell agent restart [-P] [--password] [--seekdb] [-6]
# example
obshell agent restart --seekdb --port 2886
```
The following table describes the options.
| Option | Required | Data type | Default value | Description |
| --- | --- | --- | --- | --- |
| -P/--port | No | int | 2886 | The port number to which the obshell is bound. |
| --password | No | string | N/A | This option is used only for taking over a seekdb instance. When you take over a seekdb instance, you must use this option to specify the password of the root user of the seekdb instance. You can also specify the root user password by using the `OB_ROOT_PASSWORD` environment variable. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
## Upgrade obshell
You can run this command to upgrade obshell.
```shell
obshell agent upgrade -d [-V] [-t] [--port] [--seekdb] [-6] [-y] [-v]
# example
obshell agent upgrade -d /home/oceanbase/upgrade/ -V 4.2.2.0-20231224224959 --port 2886 --seekdb
```
The following table describes the options.
| Option | Required | Data type | Default value | Description |
| --- | --- | --- | --- | --- |
| -d/--pkg_directory | Yes | string | N/A | The path where the upgrade package is stored. |
| -V/--target_version | No | string | N/A | The target version. The value must be in the correct format, such as `4.2.2.0` or `4.2.2.0-20231224224959`. If you do not specify this option, the highest version of the obshell RPM package in the directory specified by the `-d` option is selected. |
| -t/--tmp_directory | No | string | `${home_path}`/upgrade | The temporary directory for the upgrade process. This directory stores the downloaded installation package and all files generated during the decompression and installation process. The value must be an absolute path. |
| --port | No | int | 2886 | The port number of obshell. If you do not specify this option, you can specify the obshell port by setting the `OBSHELL_PORT_FOR_SEEKDB` environment variable. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command is applied to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If you specify this option, the system does not prompt you for confirmation when it performs an upgrade. |
| -v/--verbose | No | N/A | N/A | This option does not require a value. If you specify this option, the system displays detailed execution information. |

93
skills/seekdb-docs/official-docs/400.guides/1000.obshell/300.obshell-clients/200.seekdb-commands.md Normal file
View File

@@ -0,0 +1,93 @@
---
slug: /seekdb-commands
---
# obshell seekdb commands
This topic describes the seekdb commands in obshell. You can use the commands to manage a seekdb instance. You can use the `-h`/`--help` option in a command to view the help information of the command, for example, `obshell seekdb start -h`. You can also use the `-v`/`--verbose` option to view the detailed execution process of the command.
:::info
The seekdb commands are designed for managing a seekdb instance. You do not need to explicitly specify the <code>--seekdb</code> option when you execute these commands.
:::
## obshell seekdb start
You can run this command to start seekdb.
```shell
obshell seekdb start [--port] [--seekdb] [-6]
# example
obshell seekdb start --port 2886
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
## obshell seekdb restart
You can run this command to restart seekdb.
```shell
obshell seekdb restart [-t] [--port] [--seekdb] [-6] [-y]
# example
obshell seekdb restart -t --port 2886
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -t/--terminate | No | N/A | N/A | This option does not require a value. If you specify this option, the `MINOR FREEZE` command is triggered before seekdb is restarted. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If you specify this option, the confirmation for the restart operation is skipped. |
## obshell seekdb stop
You can run this command to stop seekdb.
```shell
obshell seekdb stop [-t] [--port] [--seekdb] [-6] [-y]
# example
obshell agent stop -t --port 2886
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -t/--terminate | No | N/A | N/A | This option does not require a value. If you specify this option, the `MINOR FREEZE` command is triggered before the seekdb process is stopped. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If you specify this option, the confirmation for the stop operation is skipped. |
## obshell seekdb show
You can run this command to view the configurations and status of seekdb.
```shell
obshell seekdb show [-d] [--port] [--seekdb] [-6]
# example
obshell agent show
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -d/--show_detail | No | N/A | N/A | This option does not require a value. If you specify this option, the command displays the details of seekdb. |
| --port | No | int | 2886 | Specifies the port number of obshell. If you do not want to specify the port number by using this option, you can also specify the port number of obshell by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |

134
skills/seekdb-docs/official-docs/400.guides/1000.obshell/300.obshell-clients/300.utilities-commands.md Normal file
View File

@@ -0,0 +1,134 @@
---
slug: /utilities-commands
---
# obshell task commands
This topic describes the task commands of obshell, which are used to manage obshell tasks. You can use the `-h`/`--help` option in a command to view the help information of the command. For example, you can run the `obshell task show -h --seekdb` command to view the help information of the `show` command for seekdb. In this command, `--seekdb` indicates that the help information of the `show` command for seekdb is to be viewed.
## obshell task show
You can run this command to view information about a task.
```shell
obshell task show [-i] [-d] [--port] [--seekdb] [-6] [-v]
# example
obshell task show --seekdb --port 2886
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | No | string | N/A | The ID of the task to be viewed. If this option is not specified, the current task is displayed. If no task is being executed, no task information is displayed. |
| -d/--show_detail | No | N/A | N/A | This option does not require a value. If this option is specified, detailed information about the task is displayed. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If this option is specified, the command is applied to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If this option is specified, IPv6 is used. |
| -v/--verbose | No | N/A | N/A | This option does not require a value. If this option is specified, detailed execution process information is displayed. |
## obshell task cancel
You can run this command to cancel an uncompleted task.
```shell
obshell task cancel -i [--port] [--seekdb] [-6] [-y]
# example
obshell task cancel -i 11 --seekdb
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | Yes | string | N/A | The ID of the task to be canceled. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If this option is specified, the command is applied to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If this option is specified, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If this option is specified, the command skips the confirmation. |
## obshell task rollback
You can run this command to roll back a failed task.
```shell
obshell task rollback -i [--port] [--seekdb] [-6] [-y]
# example
obshell task rollback -i 11 --seekdb
```
The following table describes the options.
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | Yes | string | N/A | The ID of the task to be rolled back. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If this option is specified, the command is applied to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If this option is specified, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If this option is specified, the command skips the confirmation. |
## obshell task retry
You can run this command to retry a failed task.
```shell
obshell task retry -i [--port] [--seekdb] [-6] [-y]
# example
obshell task retry -i 11 --seekdb
```
The options are described in the following table:
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | Yes | string | N/A | The ID of the task to be retried. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If you specify this option, the command skips the confirmation. |
## obshell task pass
You can run this command to skip a failed task.
```shell
obshell task pass -i [--port] [--seekdb] [-6] [-y]
# example
obshell task pass -i 11 --seekdb
```
The options are described in the following table:
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | Yes | string | N/A | The ID of the task to be skipped. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |
| -y/--yes | No | N/A | N/A | This option does not require a value. If you specify this option, the command skips the confirmation. |
## obshell task watch
You can run this command to view the execution progress of a specified task in real time.
```shell
obshell task watch -i [--port] [--seekdb] [-6]
# example
obshell task watch -i 11 --seekdb
```
The options are described in the following table:
| Option | Required | Data Type | Default Value | Description |
| --- | --- | --- | --- | --- |
| -i/--id | Yes | int | N/A | The ID of the running task to be viewed. |
| --port | No | int | 2886 | The port number of obshell. If you do not want to specify the port number by using this option, you can also specify it by using the environment variable `OBSHELL_PORT_FOR_SEEKDB`. |
| --seekdb | No | N/A | N/A | This option does not require a value. If you specify this option, the command applies to seekdb. |
| -6/--use-ipv6 | No | N/A | N/A | This option does not require a value. If you specify this option, IPv6 is used. |