Skip to content

Optimize directory structure: Move SKILL.md to dedicated skills directory - #8

Open
WhizZest wants to merge 1 commit into
public-clis:mainfrom
WhizZest:main
Open

Optimize directory structure: Move SKILL.md to dedicated skills directory#8
WhizZest wants to merge 1 commit into
public-clis:mainfrom
WhizZest:main

Conversation

@WhizZest

Copy link
Copy Markdown

PR Document - Optimize directory structure: Move SKILL.md to dedicated skills directory

Title

Optimize directory structure: Move SKILL.md to dedicated skills directory

Description

This commit adjusts the repository directory structure by moving the SKILL.md file from the repository root to the skills/SKILL.md dedicated directory.

Type

  • refactor - Code/directory structure refactoring

Details

Moved the SKILL.md file from the repository root to the skills/SKILL.md directory to optimize the AI Agent skills installation workflow.

Specific changes:

  • SKILL.mdskills/SKILL.md

Motivation & Background

Problem Analysis

  1. Redundant Installation Issue: In the original directory structure, when users execute npx skills add <repo>, the entire repository content is installed locally, including source code, test files, documentation, and many other unnecessary files.

  2. Actual Usage Scenario: For AI Agents, installing a skill only requires the SKILL.md file. This file contains complete information including:

    • Skill description and metadata
    • Installation steps and prerequisites
    • Command reference and usage examples
    • Agent best practices
  3. Practical Verification: Through actual usage testing, it has been verified that AI Agents only need the installation instructions in SKILL.md to complete the installation and usage of this CLI tool, without relying on scripts or other files from the repository.

Solution

By placing SKILL.md in a dedicated skills/ directory, when users execute npx skills add <repo>, the Skills CLI will only install content from the skills/ directory, achieving:

  • ✅ Minimal installation: Only the necessary SKILL.md file is installed
  • ✅ Reduced storage footprint: Avoids downloading and storing large amounts of irrelevant files
  • ✅ Improved installation efficiency: Faster installation speed
  • ✅ Clear separation of concerns: Skill definition separated from project source code

Testing & Verification

Verification Steps

  1. ✅ Confirmed SKILL.md file has been successfully moved to skills/SKILL.md
  2. ✅ Verified file content is complete and undamaged
  3. ✅ Confirmed npx skills add <repo> command can correctly identify and install the skill
  4. ✅ Verified the installed skill functions properly

Real-world Usage Verification

Through actual demonstration, the following scenarios were verified:

  • ✅ AI Agents can successfully install bilibili-cli using the installation instructions in SKILL.md
  • ✅ After installation, all features work normally (video info, subtitles, AI summary, trending videos, etc.)
  • ✅ The entire process does not rely on any scripts or other files from the repository

Related Issues

None (This is an optimization based on actual usage experience)

Impact Scope

  • ✅ No impact on existing users: Main functionality and content of the repository remain unchanged
  • ✅ Positive impact on AI Agent installation workflow: Installation becomes more efficient and concise
  • ✅ No impact on project maintenance: Source code and documentation structure remain unchanged

Backward Compatibility

  • ✅ Fully backward compatible: Does not affect existing users' usage patterns
  • ✅ Skills CLI will automatically recognize SKILL.md in the skills/ directory

Checklist

  • Code follows project conventions
  • Documentation updated (if needed)
  • Sufficient testing performed
  • Commit message is clear and descriptive

… folder, because installing skill only requires the SKILL.md file.
@WhizZest
WhizZest deleted the branch public-clis:main March 22, 2026 09:37
@WhizZest WhizZest closed this Mar 22, 2026
@WhizZest
WhizZest deleted the main branch March 22, 2026 09:37
@WhizZest
WhizZest restored the main branch March 22, 2026 09:39
@WhizZest WhizZest reopened this Mar 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant