Install By2kb logo

Install By2kb

Community
Charlesmpc
install-by2kb

Install, configure, update, or diagnose by2kb for an Agent user. Defaults to local faster-whisper and local Markdown; use a cloud ASR provider only when the user explicitly chooses one.

Overview

PublisherCharlesmpc
Repositoryby2kb
Skill nameinstall-by2kb
Stars
154
Forks
14
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by Charlesmpc on GitHub. Read the source before you install it.

Installation

Install the Install By2kb AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/Charlesmpc/by2kb/tree/main/skills/install-by2kb
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/Charlesmpc/by2kb.git /tmp/by2kb
mkdir -p .claude/skills
cp -r /tmp/by2kb/skills/install-by2kb .claude/skills/install-by2kb
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Install By2kb in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Install By2kb on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Install By2kb is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Install by2kb

Install by2kb as an independent CLI package, then install its adapter into the active Agent. Do not clone or inspect the by2kb source repository as an installation method.

Before changing the system

  1. Confirm the target machine is controlled by the user.
  2. Check for Python 3.12+, pipx, ffmpeg, ffprobe, by2kb, and the Agent host. Check uv tool list too if uv is available; keep using the existing package manager, rather than creating a second installation. A command missing on Windows may be a PATH issue: inspect Get-Command, uv tool dir --bin, or py -m pipx environment as applicable, and check the gateway's environment.
  3. If by2kb already has configuration, do not replace it. Run by2kb doctor --json, explain any failures, and preserve the current ASR and knowledge-base choices unless the user asks to change them.

For enabled YouTube/yt-dlp routes, check by2kb doctor --json for matching EJS scripts and Deno 2.3+ or Node.js 22+. Reuse a supported existing runtime. Explain and obtain agreement before installing a missing runtime with a trusted package manager; no browser is required. If the gateway PATH differs, configure only [sources.yt_dlp] js_runtime and js_runtime_path, preserving all other keys. Do not respond to a missing JS dependency by requesting login Cookies, enabling remote script downloads, or resetting configuration. Passing JS checks does not guarantee that YouTube will permit a particular video or anonymous session. If YouTube requests authentication, have the user sign in on the agent host and authorize use of a specific local browser profile. A Cookie-export extension is optional. Use a supported browser name in cookies_from_browser, or a private, YouTube-only cookie_file for a custom profile, never both. Do not expose Cookie values or unrelated sessions. Login can expire and is not a guarantee of access; browsers and PO Token services remain opt-in. Verify one selected video after setup.

Default: local Agent installation

Use this path unless the user explicitly requests cloud ASR:

  1. Install from PyPI with pipx install "by2kb[asr-whisper,youtube]".
  2. Create a cloud-free Agent configuration with by2kb init --preset agent-local. This selects local faster-whisper, Bilibili and YouTube sources, Agent-hosted summarization, and a local Markdown library.
  3. Before downloading a Whisper model, tell the user its name and that the download can be large. Continue only after the user agrees, then run by2kb models install.
  4. For Hermes, inspect hermes plugins list first. If the by2kb plugin is already installed, keep it and use skill_view("by2kb:install-by2kb") when available. Only for a new legacy/copy-based adapter install, run by2kb agent install hermes. Then run by2kb doctor --json. Catalog submission is pending; do not assume the bare catalog name is already available.
  5. Restarting a running Agent can interrupt the current conversation. Ask before restarting it, then verify the gateway and ask the user to send one test video URL.

If pipx reports that by2kb is already installed, try pipx upgrade by2kb. If an old direct-URL installation remains pinned or its virtual environment is broken, explain the problem and ask before uninstalling and reinstalling it. Never delete a pipx environment manually without explicit user approval.

Upgrade without losing personalization

Treat $BY2KB_HOME (normally ~/.by2kb) and the configured knowledge-base folder as user-owned state. An upgrade must preserve config.toml, .env, by2kb.db, downloaded models, custom Skills, and every knowledge artifact.

  1. Inspect by2kb version, pipx list, and by2kb doctor --json first.
  2. Run pipx upgrade by2kb. Do not run by2kb init, by2kb init --force, or rewrite configuration during an ordinary upgrade.
  3. Inspect hermes plugins list and the installation source. For a catalog plugin, use hermes plugins update by2kb; for a Git-pinned plugin, let the user choose a new exact commit through Hermes. Never overwrite either with the CLI installer. Only a legacy/copy-based adapter may be refreshed with by2kb agent install hermes --force. If ownership is unclear, stop and inspect it.
  4. Run by2kb doctor --json again and report any migration or restart requirement.

The Hermes adapter directory is program-owned. Put a personalized runtime Skill at $BY2KB_HOME/skills/video-to-knowledge/SKILL.md, or set BY2KB_HERMES_SKILL to an explicit file; both take precedence over the packaged Skill and survive adapter replacement. Other enrichment Skills belong under $BY2KB_HOME/skills and already take precedence over packaged defaults.

Optional: cloud ASR

Use this path only when the user chooses Doubao ASR or cannot run Whisper locally:

  1. Install pipx install "by2kb[asr-doubao,youtube]".
  2. Run by2kb init in a trusted local terminal and select doubao when prompted.
  3. Do not ask the user to paste TOS or ASR credentials into an IM conversation. The initializer stores secrets in the local by2kb .env file.
  4. Install the Agent adapter and run by2kb doctor --json as above.

Stop and report the exact failed check when a required runtime, credential, permission, model download, or Agent restart needs user action. Do not weaken permissions or switch providers merely to make diagnostics pass.

Frequently asked questions

What does the Install By2kb AI skill do?

Install, configure, update, or diagnose by2kb for an Agent user. Defaults to local faster-whisper and local Markdown; use a cloud ASR provider only when the user explicitly chooses one.

Why use Install By2kb on TypingMind?

Because you install it once and use it with any model. Install By2kb is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Install By2kb in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/Charlesmpc/by2kb/tree/main/skills/install-by2kb. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Install By2kb?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Install By2kb?

As many as you like. As long as a model supports skills, you can use Install By2kb with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Install By2kb AI skill free?

Yes. It is published on GitHub by Charlesmpc under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇