docs: Add documentation for adding new features by tvpeter · Pull Request #302 · bitcoindevkit/bdk-cli

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

tvpeter · 2026-07-14T00:39:33Z

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes#298

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

codecov · 2026-07-14T00:41:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (b0e6a3c) to head (7e4a0ca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #302 +/- ##
=======================================
Coverage 57.45% 57.45% =======================================
Files 22 22 Lines 3695 3695 =======================================
Hits 2123 2123 Misses 1572 1572

Flag	Coverage Δ
rust	`57.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Musab1258 · 2026-07-18T16:19:49Z

+ fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
+ // Access the loaded wallet via the context state
+ let wallet = &contex.state.wallet;


nit: Is the contex parameter here a typo or intentional?

Typo. Fixed. Thank you

vadim-anfv

Concept ACK 8f27808

One thing worth fixing before merge - the Step 3 example doesn't compile as-is - the imports don't resolve (details inline).

vadim-anfv · 2026-07-20T12:15:49Z

+use crate::context::{AppContext, OfflineOperations};
+use crate::commands::AppCommand;
+use crate::error::Error;


I copied the guide's snippets (Steps 1-3) into a single module and ran cargo check - the imports in Step 3 don't resolve:
error[E0432]: unresolved import `crate::context` | ^^^^^^^ could not find `context` in the crate root error[E0432]: unresolved import `crate::commands::AppCommand` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `AppCommand` in `commands` error[E0603]: derive macro import `Error` is private
There's no context module; AppContext/OfflineOperations/AppCommand all live in crate::handlers, and crate::error::Error resolves to thiserror's private derive macro rather than the error type (which is BDKCliError). The paths the real handlers use:
usecrate::handlers::{AppCommand,AppContext,OfflineOperations};usecrate::error::BDKCliErrorasError;

vadim-anfv · 2026-07-20T12:21:04Z

+
+## Adding a command/feature in bdk-cli
+
+The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.


Minor doc-style suggestion: since this is a reference guide for the current architecture, describing the design as it is now (rather than "PR #278 introduced ...") would age better. The #278 link still works as background, e.g. "(see #278 for the original design discussion)".

vadim-anfv

ACK 7e4a0ca

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026

github-project-automationBot added this to BDK-CLI Jul 14, 2026

tvpeter self-assigned this Jul 14, 2026

tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026

tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6Compare July 18, 2026 00:23

Musab1258 approved these changes Jul 18, 2026
View reviewed changes

Musab1258 reviewed Jul 18, 2026
View reviewed changes

tvpeter force-pushed the docs/adding-a-feature branch from 14c34d6 to 8f27808Compare July 19, 2026 03:30

vadim-anfv reviewed Jul 20, 2026
View reviewed changes

docs: Add documentation for adding new features
7e4a0ca

tvpeter force-pushed the docs/adding-a-feature branch from 8f27808 to 7e4a0caCompare July 20, 2026 12:41

vadim-anfv approved these changes Jul 20, 2026
View reviewed changes

tvpeter merged commit ebf50f4 into bitcoindevkit:masterJul 22, 2026
9 checks passed

github-project-automationBot moved this to Done in BDK-CLI Jul 22, 2026


		## Adding a command/feature in bdk-cli

		The modular architectural redesign (PR #278) introduced a strict separation of concerns and utilizes a Typestate Pattern to prevent invalid operations. If you are a new contributor looking to add a new command or feature, this guide will walk you through the process step-by-step.

Uh oh!

Conversation

tvpeter commented Jul 14, 2026

Description

Changelog notice

Checklists

All Submissions:

Uh oh!

codecovBot commented Jul 14, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vadim-anfv left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vadim-anfv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

tvpeter commented Jul 14, 2026

Description

Changelog notice

Checklists

All Submissions:

Uh oh!

codecovBot commented Jul 14, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vadim-anfv left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vadim-anfv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

tvpeter commented Jul 14, 2026

Description

Changelog notice

Checklists

All Submissions:

Uh oh!

codecovBot commented Jul 14, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

codecovBot commented Jul 14, 2026•
edited
Loading

codecovBot commented Jul 14, 2026•
edited
Loading

codecovBot commented Jul 14, 2026•
edited
Loading

codecovBot commented Jul 14, 2026•
edited
Loading