Skip to content

docs: update docs #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dedalik merged 1 commit into from
Apr 29, 2026
Merged

docs: update docs #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
9 changes: 6 additions & 3 deletions packages/adapters/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
9 changes: 6 additions & 3 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
9 changes: 6 additions & 3 deletions packages/contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
9 changes: 6 additions & 3 deletions packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
9 changes: 6 additions & 3 deletions packages/test-vectors/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Loading