ccxt 4.4.88 → 4.4.89

package/README.md

@@ -4,7 +4,7 @@
 
 A `JavaScript` / `Python` / `PHP` / `C#` / `Go` library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.
 
-### [Install](#install) · [Usage](#usage) · [Manual](https://github.com/ccxt/ccxt/wiki) · [FAQ](https://github.com/ccxt/ccxt/wiki/FAQ) · [Examples](https://github.com/ccxt/ccxt/tree/master/examples) · [Contributing](https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md) · [Social](#social)
+### [Install](#install) · [Usage](#usage) · [Manual](https://github.com/ccxt/ccxt/wiki) · [FAQ](https://github.com/ccxt/ccxt/wiki/FAQ) · [Examples](https://github.com/ccxt/ccxt/tree/master/examples) · [Contributing](https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md) · [Disclaimer](#disclaimer) · [Social](#social)
 
 The **CCXT** library is used to connect and trade with cryptocurrency exchanges and payment processing services worldwide. It provides quick access to market data for storage, analysis, visualization, indicator development, algorithmic trading, strategy backtesting, bot programming, and related software engineering.
 
@@ -231,13 +231,13 @@ console.log(version, Object.keys(exchanges));
 
 All-in-one browser bundle (dependencies included), served from a CDN of your choice:
 
-* jsDelivr: https://cdn.jsdelivr.net/npm/ccxt@4.4.88/dist/ccxt.browser.min.js
-* unpkg: https://unpkg.com/ccxt@4.4.88/dist/ccxt.browser.min.js
+* jsDelivr: https://cdn.jsdelivr.net/npm/ccxt@4.4.89/dist/ccxt.browser.min.js
+* unpkg: https://unpkg.com/ccxt@4.4.89/dist/ccxt.browser.min.js
 
 CDNs are not updated in real-time and may have delays. Defaulting to the most recent version without specifying the version number is not recommended. Please, keep in mind that we are not responsible for the correct operation of those CDN servers.
 
 ```HTML
-<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ccxt@4.4.88/dist/ccxt.browser.min.js"></script>
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ccxt@4.4.89/dist/ccxt.browser.min.js"></script>
 ```
 
 Creates a global `ccxt` object:
@@ -325,10 +325,6 @@ You don't need the Docker image if you're not going to develop CCXT. If you just
 
 ---
 
-## Documentation
-
-Read the [Manual](https://github.com/ccxt/ccxt/wiki/) for more details.
-
 ## Usage
 
 ### Intro
@@ -611,6 +607,53 @@ Lastly, just because the signature dictates that some argument like `symbol` is
 
 You can check different examples in the `examples/go` folder.
 
+## CCXT CLI
+
+Read the documentation for more information and details: [docs](https://github.com/ccxt/ccxt/tree/master/cli/README.md)
+
+CCXT also provides a command-line interface (CLI) that enables direct interaction with any supported exchange from the terminal. You can quickly check balances, place orders, or fetch trade data—without the need to write or execute custom code. This is especially useful for simple or time-sensitive tasks that don’t warrant the overhead of building a full application.
+
+### Installation
+
+The CLI is available as a npm package and can be installed by doing
+
+```
+npm i ccxt-cli -g
+```
+
+### Usage
+
+You can use the `--help` option to view a general overview of how the CLI works. The tool allows you to invoke any CCXT method by specifying the exchange id, the methodName, and any required arguments.
+
+Examples:
+
+```
+ccxt binance createOrder BTC/USDT market buy 0.1 // places an order
+```
+If you are not sure which arguments should be provided you can always use the `explain` command.
+
+```
+ccxt explain createOrder
+```
+
+result:
+
+```
+Method: createOrder
+Usage:
+  binance createOrder <symbol> <type> <side> <amount> [price] [params]
+
+Arguments:
+  - symbol       (required) — Market symbol e.g., BTC/USDT
+  - type         (required) — (no description available)
+  - side         (required) — order side e.g., buy or sell
+  - amount       (required) — (no description available)
+  - price        (optional) — Price per unit of asset e.g., 26000.50
+  - params       (optional) — Extra parameters for the exchange e.g., { "recvWindow": 5000 }
+```
+
+You can easily provide API keys by setting them as environment varibales eg: `BINANCE_APIKEY="XXXX"` or adding them to the config file located at `$CACHE/config.json`
+
 ## Contributing
 
 Please read the [CONTRIBUTING](https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md) document before making changes that you would like adopted in the code. Also, read the [Manual](https://github.com/ccxt/ccxt/wiki) for more details.