From e603eb75ef59e74adbd412cd9ff269dd54f9a17c Mon Sep 17 00:00:00 2001 From: "Martin A. Brown" Date: Fri, 28 Aug 2026 10:24:41 -0700 Subject: [PATCH 1/2] DOC-2206 rename README.md -> README-general.md --- README-general.md | 144 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 144 ---------------------------------------------- 2 files changed, 144 insertions(+), 144 deletions(-) create mode 100644 README-general.md diff --git a/README-general.md b/README-general.md new file mode 100644 index 0000000..5975985 --- /dev/null +++ b/README-general.md @@ -0,0 +1,144 @@ +[![](images/hdxcli.png)](https://github.com/hydrolix/hdx-cli) + + +`hdxcli` is the command-line tool to work with your Hydrolix clusters. It helps you manage resources like projects, tables, and Service Accounts. You can use it to automate tasks and include Hydrolix in your scripts and workflows. + + +## System Requirements +- Python: `>= 3.10` + +Make sure you have the correct Python version installed. + +## Installation +You can install hdxcli using pip: +```shell + pip install hdxcli +``` + +# First Steps: Initial Setup +When you run your first `hdxcli` command (for example, `hdxcli project list`), if the CLI does not find a previous setup, it will guide you to create a 'default' connection profile. You will need to enter: + +1. The **hostname** of your Hydrolix cluster (e.g., `mycluster.hydrolix.live`). +2. If the connection will use **TLS (https)** (recommended). + +After setting up the profile, you will be asked to log in with your Hydrolix **username and password**. After a successful login, you can choose how the CLI will authenticate for future operations: + +- Continue using your user credentials. +- Set up the CLI to use a **Service Account**. This is useful for longer sessions or for automated scripts. + +You can also start this setup process yourself by running: +```shell + hdxcli init +``` +This command is good if you prefer to set up the CLI before running other commands. + +## General Usage +The main way to use commands is: + +`hdxcli [GLOBAL OPTIONS] RESOURCE [ACTION] [SPECIFIC ARGUMENTS...]` + +For example, `hdxcli project list` or `hdxcli table --project myproject create mytable` + +### Common Global Options (see hdxcli --help for all options): +- `--profile PROFILE_NAME`: Use a specific connection profile. +- `--username USERNAME`: Username for login (if needed). +- `--password PASSWORD`: Password for login (if `--username` is used). +- `--uri-scheme [http|https]`: Choose the connection scheme (http or https). +- `--timeout SECONDS`: Timeout for API requests. + +- ### Connection Profiles +Profiles let you save settings for different Hydrolix clusters or users. + +- List profiles: `hdxcli profile list` +- View details of the 'default' profile: `hdxcli profile show default` +- Use a profile in a command: `hdxcli --profile my_other_profile project list` + +### Default Project and Table Context +To make commands simpler, you can set a "current" or "default" project and table. + +- Set default project and table: + ```shell + hdxcli set + ``` + Example: `hdxcli set weblogs access_logs` + +- After setting defaults, commands for tables or transforms will not need `--project` or `--table` options: + ```shell + hdxcli transform show my_transform # Will use project and table set by 'set' command + ``` + +- Clear default project and table: + ```shell + hdxcli unset + ``` + +## Main Commands (Summary) +`hdxcli` commands are grouped by the type of resource they manage. Use `hdxcli --help` to see all commands. Some of the main groups are: + +- `profile`: Manage your connection profiles. +- `init`: Initialize `hdxcli` configuration. +- `set` / `unset`: Set or clear the default project/table. +- `project`: Create, list, delete, and manage projects. +- `table`: Manage tables inside projects. +- `transform`: Manage transforms. +- `service-account`: Manage Service Accounts and their tokens. +- `job`: Manage ingestion jobs. +- (Other important groups like `dictionary`, `function`, `storage`, etc.) +- `version`: Show the `hdxcli` version. + +To get help for a specific command group or command: +```shell + hdxcli project --help + hdxcli project create --help +``` + +### Usage Examples +1. Set up the CLI, log in, and list projects: + ```shell + $ hdxcli init + # ... follow prompts to set up hostname, scheme, and login ... + # ... optionally, set up a Service Account ... + + $ hdxcli project list + project_a + project_b + ``` + +2. Create a new project and then a table: + ```shell + $ hdxcli project create my_new_project + Created project 'my_new_project' + + $ hdxcli table --project my_new_project create my_new_table + Created table 'my_new_table' + ``` + +3. Set a default context and show transform details: + ```shell + $ hdxcli set my_new_project my_new_table + Profile 'default' set project/table + + $ hdxcli transform show my_existing_transform + # ... (output of the transform) ... + ``` + +4. Show project information in indented JSON format: + ```shell + $ hdxcli project show my_new_project -i + { + "name": "my_new_project", + "org_id": "xxxx-xxxx-xxxx-xxxx", + ... + } + ``` +### Getting Help +- For an overview of commands: `hdxcli --help` +- For help on a specific resource or action: `hdxcli --help` or `hdxcli --help` +- For more in-depth information, check out the [official Hydrolix documentation](https://docs.hydrolix.io/docs/hdxcli). + +## License + +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) + +This project is licensed under the terms of the **Apache License 2.0**. +You can find a copy of the license in the [LICENSE](LICENSE) file included in this repository. \ No newline at end of file diff --git a/README.md b/README.md index 5975985..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,144 +0,0 @@ -[![](images/hdxcli.png)](https://github.com/hydrolix/hdx-cli) - - -`hdxcli` is the command-line tool to work with your Hydrolix clusters. It helps you manage resources like projects, tables, and Service Accounts. You can use it to automate tasks and include Hydrolix in your scripts and workflows. - - -## System Requirements -- Python: `>= 3.10` - -Make sure you have the correct Python version installed. - -## Installation -You can install hdxcli using pip: -```shell - pip install hdxcli -``` - -# First Steps: Initial Setup -When you run your first `hdxcli` command (for example, `hdxcli project list`), if the CLI does not find a previous setup, it will guide you to create a 'default' connection profile. You will need to enter: - -1. The **hostname** of your Hydrolix cluster (e.g., `mycluster.hydrolix.live`). -2. If the connection will use **TLS (https)** (recommended). - -After setting up the profile, you will be asked to log in with your Hydrolix **username and password**. After a successful login, you can choose how the CLI will authenticate for future operations: - -- Continue using your user credentials. -- Set up the CLI to use a **Service Account**. This is useful for longer sessions or for automated scripts. - -You can also start this setup process yourself by running: -```shell - hdxcli init -``` -This command is good if you prefer to set up the CLI before running other commands. - -## General Usage -The main way to use commands is: - -`hdxcli [GLOBAL OPTIONS] RESOURCE [ACTION] [SPECIFIC ARGUMENTS...]` - -For example, `hdxcli project list` or `hdxcli table --project myproject create mytable` - -### Common Global Options (see hdxcli --help for all options): -- `--profile PROFILE_NAME`: Use a specific connection profile. -- `--username USERNAME`: Username for login (if needed). -- `--password PASSWORD`: Password for login (if `--username` is used). -- `--uri-scheme [http|https]`: Choose the connection scheme (http or https). -- `--timeout SECONDS`: Timeout for API requests. - -- ### Connection Profiles -Profiles let you save settings for different Hydrolix clusters or users. - -- List profiles: `hdxcli profile list` -- View details of the 'default' profile: `hdxcli profile show default` -- Use a profile in a command: `hdxcli --profile my_other_profile project list` - -### Default Project and Table Context -To make commands simpler, you can set a "current" or "default" project and table. - -- Set default project and table: - ```shell - hdxcli set - ``` - Example: `hdxcli set weblogs access_logs` - -- After setting defaults, commands for tables or transforms will not need `--project` or `--table` options: - ```shell - hdxcli transform show my_transform # Will use project and table set by 'set' command - ``` - -- Clear default project and table: - ```shell - hdxcli unset - ``` - -## Main Commands (Summary) -`hdxcli` commands are grouped by the type of resource they manage. Use `hdxcli --help` to see all commands. Some of the main groups are: - -- `profile`: Manage your connection profiles. -- `init`: Initialize `hdxcli` configuration. -- `set` / `unset`: Set or clear the default project/table. -- `project`: Create, list, delete, and manage projects. -- `table`: Manage tables inside projects. -- `transform`: Manage transforms. -- `service-account`: Manage Service Accounts and their tokens. -- `job`: Manage ingestion jobs. -- (Other important groups like `dictionary`, `function`, `storage`, etc.) -- `version`: Show the `hdxcli` version. - -To get help for a specific command group or command: -```shell - hdxcli project --help - hdxcli project create --help -``` - -### Usage Examples -1. Set up the CLI, log in, and list projects: - ```shell - $ hdxcli init - # ... follow prompts to set up hostname, scheme, and login ... - # ... optionally, set up a Service Account ... - - $ hdxcli project list - project_a - project_b - ``` - -2. Create a new project and then a table: - ```shell - $ hdxcli project create my_new_project - Created project 'my_new_project' - - $ hdxcli table --project my_new_project create my_new_table - Created table 'my_new_table' - ``` - -3. Set a default context and show transform details: - ```shell - $ hdxcli set my_new_project my_new_table - Profile 'default' set project/table - - $ hdxcli transform show my_existing_transform - # ... (output of the transform) ... - ``` - -4. Show project information in indented JSON format: - ```shell - $ hdxcli project show my_new_project -i - { - "name": "my_new_project", - "org_id": "xxxx-xxxx-xxxx-xxxx", - ... - } - ``` -### Getting Help -- For an overview of commands: `hdxcli --help` -- For help on a specific resource or action: `hdxcli --help` or `hdxcli --help` -- For more in-depth information, check out the [official Hydrolix documentation](https://docs.hydrolix.io/docs/hdxcli). - -## License - -[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) - -This project is licensed under the terms of the **Apache License 2.0**. -You can find a copy of the license in the [LICENSE](LICENSE) file included in this repository. \ No newline at end of file From 64a7fc27937b08e30b6cf9f2c48e7d027ab848fe Mon Sep 17 00:00:00 2001 From: "Martin A. Brown" Date: Fri, 28 Aug 2026 10:25:28 -0700 Subject: [PATCH 2/2] DOC-2206 deprecation / warning notice (except for migrate command) Set the landing page `README.md` to a warning page that indicates the `hdxcli` utility has reached the end of its life, with the singular exception of the `hdxcli migrate` command. All other (sub) commands may continue to work up through Hydrolix v6.3, but will break in a future release. Indicate very clearly that the utility is no longer seeing maintenance. Point anybody with questions to the corporate support channel. --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index e69de29..41cb149 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,34 @@ +# README + +The `hdxcli` is a publicly available command-line tool for interacting with +Hydrolix clusters. + +## Deprecated + +> [!WARNING] +> With the exception of the subcommand `hdxcli migrate`, the `hdxcli` utility +> is now unmaintained. +> +> Only emergency fixes are applied. + +## Usage documentation + +See the [original README](README-general.md) for installation and usage +instructions. + +> [!NOTE] +> The `hdxcli` tool may continue to work with Hydrolix releases up to [Hydrolix +> v6.3](https://docs.hydrolix.io/latest/release-notes/v6.3.2/). + +## Support + +If you have questions or need help, please contact [Hydrolix Customer +Success](mailto:support@hydrolix.io). + +## License + +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) + +This project is licensed under the terms of the **Apache License 2.0**. You +can find a copy of the license in the [LICENSE](LICENSE) file included in this +repository.