SKILL.md

[frnandu]

first draft to allow testing with npx skills add relaystr/ndk and use it in agents

Summary by CodeRabbit

• Documentation
  • Added a skills index listing three skills (CLI, core library, Flutter UI) with install and usage pointers.
  • Added full NDK CLI docs: installation, commands, req (relay queries), wallets (NWC/Cashu), notes, and global flags.
  • Added ndk-core docs: setup, requests/subscriptions, accounts, wallets, use cases and examples.
  • Added ndk-flutter docs: setup, widgets, and account/session management guidance.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 94d3e77c-1751-4910-bccf-d4cf98c6621b

📥 Commits

Reviewing files that changed from the base of the PR and between 3037873 and 5666645.

⛔ Files ignored due to path filters (1)

• packages/sample-app/pubspec.lock is excluded by !**/*.lock

📒 Files selected for processing (12)

• skills/README.md
• skills/ndk-core/SKILL.md
• skills/ndk-core/references/accounts.md
• skills/ndk-core/references/requests.md
• skills/ndk-core/references/setup.md
• skills/ndk-core/references/usecases.md
• skills/ndk-core/references/wallets.md
• skills/ndk-flutter/SKILL.md
• skills/ndk-flutter/references/accounts.md
• skills/ndk-flutter/references/setup.md
• skills/ndk-flutter/references/widgets.md
• skills/ndk/SKILL.md

---

📝 Walkthrough

Walkthrough

Adds a skills index and comprehensive documentation for three skills: ndk (CLI), ndk-core (Dart), and ndk-flutter (Flutter), including skill pages, installation, CLI command references (wallets, req), API/setup guides, accounts, wallets, use-cases, widgets, and operational notes.

Changes

NDK CLI Skill

Layer / File(s)	Summary
Skills index and registration skills/README.md	Registers available skills (ndk, ndk-core, ndk-flutter) with descriptions, install commands, reference links, and an "Adding a Skill" checklist.
NDK SKILL + install & commands skills/ndk/SKILL.md, skills/ndk/references/installation.md, skills/ndk/references/commands.md	Adds SKILL.md and documents installation options, environment variables, PATH setup, and the ndk CLI top-level commands and global option ordering.
Wallets and req command references skills/ndk/references/wallets.md, skills/ndk/references/req.md	Documents ndk wallets subcommands (list, add, remove, receive, send, balance, budget), persistence and security notes, walletId format, and ndk req relay querying with flags, NDJSON output, and examples.
Operational notes skills/ndk/references/notes.md	Covers wallet DB/ID conventions, wallet type behaviors (NWC/Cashu), default wallet selection, event verifier fallback behavior, verbosity flag ordering, and supported platforms.

NDK Core (Dart) Skill

Layer / File(s)	Summary
SKILL.md and quick reference skills/ndk-core/SKILL.md	Adds skill metadata and navigation for the Dart ndk core library.
Setup and requests API skills/ndk-core/references/setup.md, skills/ndk-core/references/requests.md	Documents package install, Ndk initialization (NdkConfig), engine/cache options, and low-level request/subscription APIs with filters and response lifecycle.
Accounts, use-cases, and wallets skills/ndk-core/references/accounts.md, skills/ndk-core/references/usecases.md, skills/ndk-core/references/wallets.md	Adds accounts/signers reference, illustrative use-case snippets, and experimental wallets (NWC/Cashu) usage and examples.

NDK Flutter Skill

Layer / File(s)	Summary
SKILL.md and setup skills/ndk-flutter/SKILL.md, skills/ndk-flutter/references/setup.md	Adds ndk-flutter skill page and setup guidance including i18n integration and NdkFlutter initialization with app startup flow.
Accounts and widgets skills/ndk-flutter/references/accounts.md, skills/ndk-flutter/references/widgets.md	Documents account persistence/restore with FlutterSecureStorage, available signer integrations, utility helpers, and a widgets reference with usage snippets and export location.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through docs with nimble feet,
New skills aligned, each page complete.
CLI, Dart, and Flutter in a row—
Install, connect, and off you go! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'SKILL.md' is overly vague and does not clearly summarize the main change. While the PR does add a SKILL.md file, the title fails to convey that this PR adds comprehensive documentation for the NDK skill, including installation guides, command references, and wallet operations.	Consider using a more descriptive title such as 'Add NDK skill documentation and installation guide' or 'Add skills/ndk documentation for Agent integration' to better communicate the primary purpose of the changeset.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[1-leo]

• clear seperation ndk <==> ndk_cli