From 69e3076485659506fa7e6217e571fb9d543adc97 Mon Sep 17 00:00:00 2001 From: Radiks Alijevs Date: Wed, 29 Apr 2026 18:31:59 +0300 Subject: [PATCH] docs: update docs --- README.md | 9 ++++++--- packages/adapters/README.md | 9 ++++++--- packages/cli/README.md | 9 ++++++--- packages/contracts/README.md | 9 ++++++--- packages/core/README.md | 9 ++++++--- packages/test-vectors/README.md | 9 ++++++--- 6 files changed, 36 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 09e3159..823355d 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. [![npm](https://img.shields.io/npm/v/@kiploks/engine-core)](https://www.npmjs.com/package/@kiploks/engine-core) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) diff --git a/packages/adapters/README.md b/packages/adapters/README.md index 5ce4571..c6ef3de 100644 --- a/packages/adapters/README.md +++ b/packages/adapters/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine) diff --git a/packages/cli/README.md b/packages/cli/README.md index b39f77c..5a09c36 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine) diff --git a/packages/contracts/README.md b/packages/contracts/README.md index a310871..2ac908f 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine) diff --git a/packages/core/README.md b/packages/core/README.md index 0620b8a..6553802 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine) diff --git a/packages/test-vectors/README.md b/packages/test-vectors/README.md index 822db73..5984758 100644 --- a/packages/test-vectors/README.md +++ b/packages/test-vectors/README.md @@ -6,19 +6,22 @@ You can now run Freqtrade bot tests directly from the web interface with much le https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21 +Run the UI with one of these options: + ```bash +# from engine repo root: npm install npm run ui + # or without global install: npx -y @kiploks/engine-cli ui --watch -``` +``` - Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode. - Start integration runs from a cleaner Step 4 workspace with collapsible sections. - Get report links in run logs after successful local runs, so you can open results right away. -- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes. - +- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/kiploks-freqtrade#configuration-details-kiploksjson) modes. **Repository:** [github.com/kiploks/engine](https://github.com/kiploks/engine)