hyperliquid-cli-python 0.1.4__tar.gz → 0.1.6__tar.gz

{hyperliquid_cli_python-0.1.4/src/hyperliquid_cli_python.egg-info → hyperliquid_cli_python-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperliquid-cli-python
-Version: 0.1.4
+Version: 0.1.6
 Summary: Python CLI for Hyperliquid DEX
 Author: hyperliquid-cli contributors
 License-Expression: BSD-2-Clause
@@ -13,9 +13,46 @@ Requires-Dist: hyperliquid-python-sdk>=0.18.0
 Requires-Dist: eth-account>=0.13.4
 Dynamic: license-file
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Hyperliquid CLI (Python)](#hyperliquid-cli-python)
+  - [Setup](#setup)
+    - [Requirements](#requirements)
+    - [Installation](#installation)
+    - [Bash Completion](#bash-completion)
+  - [CLI Basics](#cli-basics)
+    - [Global Options](#global-options)
+    - [Supported Commands](#supported-commands)
+    - [Configuration](#configuration)
+    - [Security Notes](#security-notes)
+  - [Development](#development)
+    - [Run for Development](#run-for-development)
+    - [JSON Pattern Tests](#json-pattern-tests)
+  - [Order Features](#order-features)
+    - [TWAP Orders](#twap-orders)
+    - [Stake-Based Orders](#stake-based-orders)
+  - [Project](#project)
+    - [Acknowledgments](#acknowledgments)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Hyperliquid CLI (Python)
 
-## Installation
+Python CLI for Hyperliquid account management, market data, and order execution.
+
+## Setup
+
+### Requirements
+
+- Python 3.10+
+- `hyperliquid-python-sdk` for API interactions
+- `rich` for pretty console output
+- `eth-account` for key management
+- Optional: `make` for installation and uninstallation scripts
+
+### Installation
 
 Install from git and also set up Bash completion with `make install`:
 
@@ -29,13 +66,13 @@ Install from source for local development:
 
 ```bash
 cd hl
-pip install -e .
+python3 -m pip install --user -e .
 ```
 
 Install from PyPI:
 
 ```bash
-pip install hyperliquid-cli-python
+pip install --user hyperliquid-cli-python
 ```
 
 After installation, the `hl` command is available:
@@ -44,7 +81,7 @@ After installation, the `hl` command is available:
 hl --help
 ```
 
-## Bash Completion
+### Bash Completion
 
 `hl` can print a Bash completion script for top-level commands and subcommands.
 
@@ -72,12 +109,14 @@ To remove the package and any managed `~/.bashrc` completion line:
 make uninstall
 ```
 
-## Global Options
+## CLI Basics
+
+### Global Options
 
 - `--json` Output JSON
 - `--testnet` Use testnet
 
-## Supported Commands
+### Supported Commands
 
 - `hl account add|ls|set-default|remove`
 - `hl account positions|orders|balances|portfolio`
@@ -86,7 +125,7 @@ make uninstall
 - `hl markets ls|search`
 - `hl referral set|status`
 
-## Configuration
+### Configuration
 
 - DB: `~/.hl/hl.db`
 - Order config: `~/.hl/order-config.json`
@@ -96,7 +135,7 @@ Environment variable fallback (when DB account is not configured):
 - `HYPERLIQUID_PRIVATE_KEY`
 - `HYPERLIQUID_WALLET_ADDRESS`
 
-## Security Notes
+### Security Notes
 
 Account data stored in `~/.hl/hl.db` is encrypted at rest for these fields:
 
@@ -155,14 +194,16 @@ Practical guidance:
 - Restrict which OS user can run this tool
 - If you need stronger protection, use disk encryption as the higher-level control
 
-## Run for Development
+## Development
+
+### Run for Development
 
 ```bash
 cd hl
 PYTHONPATH=src python -m hl_cli.cli.argparse_main --help
 ```
 
-## JSON Pattern Tests
+### JSON Pattern Tests
 
 `tests/` validates that every subcommand pattern produces parseable raw JSON output in `--json` mode.
 
@@ -171,29 +212,49 @@ cd hl
 PYTHONPATH=src python -m unittest -v tests.test_json_patterns
 ```
 
-## TWAP Orders
+## Order Features
+
+Order side semantics:
+
+- `buy` / `sell` are for spot markets
+- `long` / `short` are for perp markets
+- `close` is for closing an open perp position
+
+### TWAP Orders
 
 `hyperliquid-python-sdk` does not provide a high-level TWAP method, so this CLI signs and submits the official
-`exchange` actions `twapOrder` / `twapCancel`.
+`exchange` actions `twapOrder` / `twapCancel`. Successful submissions store the returned `twapId`
+locally under `~/.hl/twap_orders.json` so the CLI can show and cancel tracked TWAPs later.
+
+TWAP is perp-only, so use `long` / `short`.
 
 ```bash
 # 30-minute native TWAP
-hl order twap buy 1.0 BTC 30
+hl order twap long 1.0 BTC 30
 
 # Derive total TWAP size from USD margin (stake * leverage)
-hl order twap buy 0 BTC 30 --stake 5
+hl order twap long 0 BTC 30 --stake 5
 
 # Compatibility format: 5,10 is sent as total 50 minutes
-hl order twap sell 2.0 ETH 5,10 --randomize
+hl order twap short 2.0 ETH 5,10 --randomize
 
 # Cancel TWAP
 hl order twap-cancel BTC 12345
+
+# Or list tracked active TWAPs and pick one interactively
+hl order twap-cancel
 ```
 
-## Stake-Based Orders
+### Stake-Based Orders
 
 `--stake` is used by the CLI to derive order size.
 
+Mode-specific behavior:
+
+- `buy` / `sell` derive spot order size
+- `long` / `short` derive perp order size
+- `--leverage`, `--cross`, `--isolated`, and `--reduce-only` are only supported with `long` / `short`
+
 - If you pass `--stake 50 --leverage 20`, the CLI derives size from about `$1000`
   of notional (`50 * 20`).
 - If you pass `--stake 50` without `--leverage`, the CLI derives size from about
@@ -216,17 +277,17 @@ So:
   shown later in `hl account positions`
 
 ```bash
-# No --leverage: CLI sizes the order from about $50 of BTC notional
-hl order market buy BTC --stake 50
+# Spot buy: CLI sizes the order from about $50 of spot notional
+hl order market buy @142 --stake 50
 
-# No --leverage: CLI sizes the order from about $50 of ETH notional
-hl order market buy ETH --stake 50
+# Spot sell: CLI sizes the order from about $50 of spot notional
+hl order market sell @142 --stake 50
 
-# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
-hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
+# Perp long with leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order limit long BTC 65000 --stake 50 --leverage 20 --cross
 
-# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
-hl order market buy BTC --stake 50 --leverage 20 --isolated
+# Perp long with leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order market long BTC --stake 50 --leverage 20 --isolated
 
 # Example:
 # BTC at 69,000
@@ -238,8 +299,8 @@ hl order market buy BTC --stake 50 --leverage 20 --isolated
 # - --stake 50 --leverage 20   => about 0.2475 ETH
 
 # Set leverage and margin mode at order time
-hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
-hl order market buy BTC --stake 50 --leverage 20 --isolated
+hl order limit long BTC 65000 --stake 50 --leverage 20 --cross
+hl order market long BTC --stake 50 --leverage 20 --isolated
 
 # Set leverage directly
 hl order set-leverage BTC 20 --cross
@@ -259,7 +320,9 @@ hl order tpsl ETH --tp 1900 --sl 1800
 hl order tpsl ETH --sl 1800 --ratio 0.5
 ```
 
-## Acknowledgments
+## Project
+
+### Acknowledgments
 
 - https://app.hyperliquid.xyz/
 - https://github.com/chrisling-dev/hyperliquid-cli

{hyperliquid_cli_python-0.1.4 → hyperliquid_cli_python-0.1.6}/README.md

@@ -1,6 +1,43 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Hyperliquid CLI (Python)](#hyperliquid-cli-python)
+  - [Setup](#setup)
+    - [Requirements](#requirements)
+    - [Installation](#installation)
+    - [Bash Completion](#bash-completion)
+  - [CLI Basics](#cli-basics)
+    - [Global Options](#global-options)
+    - [Supported Commands](#supported-commands)
+    - [Configuration](#configuration)
+    - [Security Notes](#security-notes)
+  - [Development](#development)
+    - [Run for Development](#run-for-development)
+    - [JSON Pattern Tests](#json-pattern-tests)
+  - [Order Features](#order-features)
+    - [TWAP Orders](#twap-orders)
+    - [Stake-Based Orders](#stake-based-orders)
+  - [Project](#project)
+    - [Acknowledgments](#acknowledgments)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Hyperliquid CLI (Python)
 
-## Installation
+Python CLI for Hyperliquid account management, market data, and order execution.
+
+## Setup
+
+### Requirements
+
+- Python 3.10+
+- `hyperliquid-python-sdk` for API interactions
+- `rich` for pretty console output
+- `eth-account` for key management
+- Optional: `make` for installation and uninstallation scripts
+
+### Installation
 
 Install from git and also set up Bash completion with `make install`:
 
@@ -14,13 +51,13 @@ Install from source for local development:
 
 ```bash
 cd hl
-pip install -e .
+python3 -m pip install --user -e .
 ```
 
 Install from PyPI:
 
 ```bash
-pip install hyperliquid-cli-python
+pip install --user hyperliquid-cli-python
 ```
 
 After installation, the `hl` command is available:
@@ -29,7 +66,7 @@ After installation, the `hl` command is available:
 hl --help
 ```
 
-## Bash Completion
+### Bash Completion
 
 `hl` can print a Bash completion script for top-level commands and subcommands.
 
@@ -57,12 +94,14 @@ To remove the package and any managed `~/.bashrc` completion line:
 make uninstall
 ```
 
-## Global Options
+## CLI Basics
+
+### Global Options
 
 - `--json` Output JSON
 - `--testnet` Use testnet
 
-## Supported Commands
+### Supported Commands
 
 - `hl account add|ls|set-default|remove`
 - `hl account positions|orders|balances|portfolio`
@@ -71,7 +110,7 @@ make uninstall
 - `hl markets ls|search`
 - `hl referral set|status`
 
-## Configuration
+### Configuration
 
 - DB: `~/.hl/hl.db`
 - Order config: `~/.hl/order-config.json`
@@ -81,7 +120,7 @@ Environment variable fallback (when DB account is not configured):
 - `HYPERLIQUID_PRIVATE_KEY`
 - `HYPERLIQUID_WALLET_ADDRESS`
 
-## Security Notes
+### Security Notes
 
 Account data stored in `~/.hl/hl.db` is encrypted at rest for these fields:
 
@@ -140,14 +179,16 @@ Practical guidance:
 - Restrict which OS user can run this tool
 - If you need stronger protection, use disk encryption as the higher-level control
 
-## Run for Development
+## Development
+
+### Run for Development
 
 ```bash
 cd hl
 PYTHONPATH=src python -m hl_cli.cli.argparse_main --help
 ```
 
-## JSON Pattern Tests
+### JSON Pattern Tests
 
 `tests/` validates that every subcommand pattern produces parseable raw JSON output in `--json` mode.
 
@@ -156,29 +197,49 @@ cd hl
 PYTHONPATH=src python -m unittest -v tests.test_json_patterns
 ```
 
-## TWAP Orders
+## Order Features
+
+Order side semantics:
+
+- `buy` / `sell` are for spot markets
+- `long` / `short` are for perp markets
+- `close` is for closing an open perp position
+
+### TWAP Orders
 
 `hyperliquid-python-sdk` does not provide a high-level TWAP method, so this CLI signs and submits the official
-`exchange` actions `twapOrder` / `twapCancel`.
+`exchange` actions `twapOrder` / `twapCancel`. Successful submissions store the returned `twapId`
+locally under `~/.hl/twap_orders.json` so the CLI can show and cancel tracked TWAPs later.
+
+TWAP is perp-only, so use `long` / `short`.
 
 ```bash
 # 30-minute native TWAP
-hl order twap buy 1.0 BTC 30
+hl order twap long 1.0 BTC 30
 
 # Derive total TWAP size from USD margin (stake * leverage)
-hl order twap buy 0 BTC 30 --stake 5
+hl order twap long 0 BTC 30 --stake 5
 
 # Compatibility format: 5,10 is sent as total 50 minutes
-hl order twap sell 2.0 ETH 5,10 --randomize
+hl order twap short 2.0 ETH 5,10 --randomize
 
 # Cancel TWAP
 hl order twap-cancel BTC 12345
+
+# Or list tracked active TWAPs and pick one interactively
+hl order twap-cancel
 ```
 
-## Stake-Based Orders
+### Stake-Based Orders
 
 `--stake` is used by the CLI to derive order size.
 
+Mode-specific behavior:
+
+- `buy` / `sell` derive spot order size
+- `long` / `short` derive perp order size
+- `--leverage`, `--cross`, `--isolated`, and `--reduce-only` are only supported with `long` / `short`
+
 - If you pass `--stake 50 --leverage 20`, the CLI derives size from about `$1000`
   of notional (`50 * 20`).
 - If you pass `--stake 50` without `--leverage`, the CLI derives size from about
@@ -201,17 +262,17 @@ So:
   shown later in `hl account positions`
 
 ```bash
-# No --leverage: CLI sizes the order from about $50 of BTC notional
-hl order market buy BTC --stake 50
+# Spot buy: CLI sizes the order from about $50 of spot notional
+hl order market buy @142 --stake 50
 
-# No --leverage: CLI sizes the order from about $50 of ETH notional
-hl order market buy ETH --stake 50
+# Spot sell: CLI sizes the order from about $50 of spot notional
+hl order market sell @142 --stake 50
 
-# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
-hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
+# Perp long with leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order limit long BTC 65000 --stake 50 --leverage 20 --cross
 
-# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
-hl order market buy BTC --stake 50 --leverage 20 --isolated
+# Perp long with leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order market long BTC --stake 50 --leverage 20 --isolated
 
 # Example:
 # BTC at 69,000
@@ -223,8 +284,8 @@ hl order market buy BTC --stake 50 --leverage 20 --isolated
 # - --stake 50 --leverage 20   => about 0.2475 ETH
 
 # Set leverage and margin mode at order time
-hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
-hl order market buy BTC --stake 50 --leverage 20 --isolated
+hl order limit long BTC 65000 --stake 50 --leverage 20 --cross
+hl order market long BTC --stake 50 --leverage 20 --isolated
 
 # Set leverage directly
 hl order set-leverage BTC 20 --cross
@@ -244,7 +305,9 @@ hl order tpsl ETH --tp 1900 --sl 1800
 hl order tpsl ETH --sl 1800 --ratio 0.5
 ```
 
-## Acknowledgments
+## Project
+
+### Acknowledgments
 
 - https://app.hyperliquid.xyz/
 - https://github.com/chrisling-dev/hyperliquid-cli

{hyperliquid_cli_python-0.1.4 → hyperliquid_cli_python-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hyperliquid-cli-python"
-version = "0.1.4"
+version = "0.1.6"
 description = "Python CLI for Hyperliquid DEX"
 readme = "README.md"
 requires-python = ">=3.10"