agentleFS
iusztinpauliusztinpaul/designing-real-world-ai-agents-workshop/.agents/skills/developing-with-streamlit/SKILL.md

developing-with-streamlit

Skill512 starsChanged 7 months agoMITView on GitHub

**[REQUIRED]** Use for ALL Streamlit tasks: creating, editing, debugging, beautifying, styling, theming, optimizing, or deploying Streamlit applications. Also required for building custom components (inline or packaged), using st.components.v2, or any HTML/JS/CSS component work. Triggers: streamlit, st., dashboard, app.py, beautify, style, CSS, color, background, theme, button, widget styling, custom component, st.components, packaged component, pyproject.toml, asset_dir, CCv2, HTML/JS component.

2 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 2

    1. pp6235024-bit/claude-skills★ 012% same
    2. sid-git-repo/claude-skills★ 012% same

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository7 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this routing table to select sub-skill(s).

    line 82
  2. Very specific:

    When creating a new dashboard app, prefer starting from a template in templates/apps/:

    line 123
  3. Distinctive:

    If a template closely matches the request, copy it and adapt:

    line 124
  4. Very specific:

    If no template is a close match, start from scratch but borrow relevant patterns from the templates (e.g., caching with @st.cache_data, …

    line 131
  5. Distinctive:

    When editing an existing app, use templates as reference for best practices:

    line 134
  6. Very specific:

    Check templates/apps/ for caching patterns, layout structure, and Snowflake integration

    line 135
  7. Very specific:

    When applying a custom theme, use a template from templates/themes/:

    line 138
  8. Distinctive:

    Step 2: If multiple sub-skills seem relevant, ask user which aspect to focus on first

    line 192
  9. Distinctive:

    Step 4: Ask before starting the Streamlit app

    line 193

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Developing with Streamlit

This is a routing skill that directs you to specialized sub-skills for Streamlit development.

When to Use

Invoke this skill when the user's request involves:

  • Creating a new Streamlit app
  • Editing or modifying an existing Streamlit app
  • Debugging Streamlit issues (errors, session state bugs, performance problems)
  • Beautifying or improving the visual design of a Streamlit app
  • Optimizing Streamlit performance (caching, fragments, reruns)
  • Deploying Streamlit apps (locally or to Snowflake)
  • Styling widgets (button colors, backgrounds, CSS customization)
  • Any question about Streamlit widgets, layouts, or components

Trigger phrases: "streamlit", "st.", "dashboard", "app.py", "beautify app", "make it look better", "style", "CSS", "color", "background", "theme", "button", "slow rerun", "session state", "performance", "faster", "cache", "deploy"

Workflow

Step 1: Locate the Streamlit source code
    ↓
Step 2: Identify task type and load appropriate sub-skill(s)
    ↓
Step 3: Apply guidance from sub-skill to edit code
    ↓
Step 4: Check if app is running and offer to run it

Step 1: Locate the Streamlit Source Code (if needed)

Goal: Identify the app file(s) to edit. Skip this step if already clear from context.

When to skip:

  • User mentioned a specific file path (e.g., "edit src/app.py")
  • User has file(s) already in conversation context
  • Working directory has an obvious single entry point (app.py, streamlit_app.py)

When to search:

  • User says "my streamlit app" without specifying which file
  • Multiple Python files exist and it's unclear which is the entry point

If searching is needed:

  1. Quick scan for Streamlit files:
    find . -name "*.py" -type f | xargs grep -l "import streamlit\|from streamlit" 2>/dev/null | head -10
  2. Apply entry point heuristics (in priority order):
    • streamlit_app.py at root → this is the entry point (canonical name)
    • app.py at root → likely entry point
    • File using st.navigation → entry point for multi-page apps
    • Single .py file at root with streamlit import → entry point
    • Files in pages/ or app_pages/ subdirectory → NOT entry points (these are sub-pages)
  3. If entry point is obvious → use it, no confirmation needed

    Example: Found streamlit_app.py and pages/metrics.py → use streamlit_app.py

  4. Only ask if genuinely ambiguous (e.g., multiple root-level candidates, none named streamlit_app.py):
    Found multiple potential entry points:
    - dashboard.py
    - main.py
    
    Which is your main app?

Output: Path to the main Streamlit source file(s)

Step 2: Identify Task Type and Route to Sub-Skill

Goal: Determine what the user needs and load the appropriate guidance.

Use this routing table to select sub-skill(s). Always read the sub-skill file before making changes:

User NeedSub-skill to Read
Performance issues, slow apps, cachingread skills/optimizing-streamlit-performance/SKILL.md
Building a dashboard with KPIs/metricsread skills/building-streamlit-dashboards/SKILL.md
Improving visual design, icons, polishread skills/improving-streamlit-design/SKILL.md
Choosing widgets (selectbox vs radio vs pills)read skills/choosing-streamlit-selection-widgets/SKILL.md
Styling widgets (button colors, backgrounds, CSS)read skills/creating-streamlit-themes/SKILL.md
Layouts (columns, tabs, sidebar, containers)read skills/using-streamlit-layouts/SKILL.md
Displaying data (dataframes, charts)read skills/displaying-streamlit-data/SKILL.md
Multi-page app architectureread skills/building-streamlit-multipage-apps/SKILL.md
Session state and callbacksread skills/using-streamlit-session-state/SKILL.md
Markdown, colored text, badgesread skills/using-streamlit-markdown/SKILL.md
Custom themes and colorsread skills/creating-streamlit-themes/SKILL.md
Comprehensive theme design and brand alignmentread skills/creating-streamlit-themes/SKILL.md
Chat interfaces and AI assistantsread skills/building-streamlit-chat-ui/SKILL.md
Connecting to Snowflakeread skills/connecting-streamlit-to-snowflake/SKILL.md
Building or packaging a custom component, triggering events back to Python from JS/HTML, custom HTML/JS with event handling (CCv2), OR any UI element that doesn't exist as a native Streamlit widget (e.g., drag-and-drop, custom interactive visualization, canvas drawing)read skills/building-streamlit-custom-components-v2/SKILL.md — IMPORTANT: st.components.v1 is deprecated. Never use v1 for new components; always use st.components.v2.component().
Third-party componentsread skills/using-streamlit-custom-components/SKILL.md
Code organizationread skills/organizing-streamlit-code/SKILL.md
Environment setupread skills/setting-up-streamlit-environment/SKILL.md
CLI commandsread skills/using-streamlit-cli/SKILL.md

Fallback — "this widget doesn't exist in Streamlit":

If the user asks for a UI element or interaction that has never been part of Streamlit's API and cannot be built with any combination of native widgets (e.g., drag-and-drop, canvas drawing, custom interactive visualizations), route to the CCv2 sub-skill (skills/building-streamlit-custom-components-v2/SKILL.md). Do not route to CCv2 for features that exist in newer Streamlit versions (e.g., st.connection, st.segmented_control) — suggest upgrading instead.

Common combinations:

For beautifying/improving an app, read in order:

  1. skills/improving-streamlit-design/SKILL.md
  2. skills/using-streamlit-layouts/SKILL.md
  3. skills/choosing-streamlit-selection-widgets/SKILL.md

For building a dashboard, read:

  1. skills/building-streamlit-dashboards/SKILL.md
  2. skills/displaying-streamlit-data/SKILL.md

IMPORTANT - Use templates:

When creating a new dashboard app, prefer starting from a template in templates/apps/:

  • If a template closely matches the request, copy it and adapt:
    • dashboard-metrics / dashboard-metrics-snowflake — KPI cards with time-series charts
    • dashboard-companies — company/entity comparison
    • dashboard-compute / dashboard-compute-snowflake — resource/credit monitoring
    • dashboard-feature-usage — feature adoption tracking
    • dashboard-seattle-weather — public dataset exploration (local only)
    • dashboard-stock-peers / dashboard-stock-peers-snowflake — financial peer analysis
  • If no template is a close match, start from scratch but borrow relevant patterns from the templates (e.g., caching with @st.cache_data, filter_by_time_range(), st.set_page_config(), chart utilities, layout structure)
  • See templates/apps/README.md for template descriptions

When editing an existing app, use templates as reference for best practices:

  • Check templates/apps/ for caching patterns, layout structure, and Snowflake integration
  • Apply consistent patterns from templates to improve the existing code

When applying a custom theme, use a template from templates/themes/:

  • Copy a theme directory (snowflake, dracula, nord, stripe, solarized-light, spotify, github, minimal)
  • Themes use Google Fonts for easy setup
  • See templates/themes/README.md for theme previews

For performance optimization, read:

  1. skills/optimizing-streamlit-performance/SKILL.md

Step 3: Apply Guidance to Edit Code

Goal: Make changes to the Streamlit app following sub-skill best practices.

Actions:

  1. Apply the patterns and recommendations from the loaded sub-skill(s)
  2. Make edits to the source file(s) identified in Step 1
  3. Preserve existing functionality while adding improvements

Step 4: Check Running Apps and Offer to Run

Goal: Help the user see their changes by checking if their app is running.

Actions:

  1. Check for running Streamlit apps on ports 850*:
    lsof -nP -iTCP -sTCP:LISTEN 2>/dev/null | grep -i python | awk '{print $2, $9}' | grep ':85' || echo "No Streamlit apps detected on ports 850*"
  2. Present findings to user:

    If app is running:

    Found Streamlit app running:
    - PID: [pid] at http://localhost:[port]
    
    Your changes should be visible after a page refresh (Streamlit hot-reloads on file save).

    If no app is running:

    No Streamlit app detected on ports 850*.
    
    Would you like me to run the app? I can start it with:
      streamlit run [app_file.py]
  3. If user wants to run the app, start it:
    streamlit run [path/to/app.py] --server.port 8501

Stopping Points

  • Step 2: If multiple sub-skills seem relevant, ask user which aspect to focus on first
  • Step 4: Ask before starting the Streamlit app

Skill map

SkillCovers
building-streamlit-chat-uiChat interfaces, streaming responses, message history
building-streamlit-dashboardsKPI cards, metrics, dashboard layouts
building-streamlit-multipage-appsPage structure, navigation, shared state
building-streamlit-custom-components-v2Streamlit Custom Components v2 (inline and template-based packaged), bidirectional state/trigger callbacks, bundling, theme CSS variables
choosing-streamlit-selection-widgetsSelectbox vs radio vs segmented control vs pills vs multiselect
connecting-streamlit-to-snowflakest.connection, query caching, credentials
creating-streamlit-themesTheme configuration, colors, fonts, light/dark modes, professional brand alignment, CSS avoidance
displaying-streamlit-dataDataframes, column config, charts
improving-streamlit-designIcons, badges, colored text, visual polish
optimizing-streamlit-performanceCaching, fragments, forms, static vs dynamic widgets
organizing-streamlit-codeWhen to split into modules, separating UI from logic
setting-up-streamlit-environmentPython environment, dependency management
using-streamlit-custom-componentsThird-party components from the community
using-streamlit-cliCLI commands, running apps
using-streamlit-layoutsSidebar, columns, containers, tabs, expanders, dialogs, alignment, spacing
using-streamlit-markdownColored text, badges, icons, LaTeX, and all markdown features
using-streamlit-session-stateSession state, widget keys, callbacks, state persistence

Resources

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.