streamlit specs.instructions.md

A set of instructions for writing Streamlit product and technical specifications. A product specification describes what a user-facing feature should do; a technical specification describes its internal design.

In plain words
What is it for?
Planning significant features, API changes, architecture work, frontend or backend designs, and related technical decisions.
Why use it?
It helps teams decide when a specification is needed and keeps the problem, solution, and implementation details organized.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/streamlit/streamlit/specs
Clone the repo
git clone --depth 1 https://github.com/streamlit/streamlit

Made for: GitHub Copilot.

Per session 3,922 This file is loaded in full into every session.
When invoked 3,922 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.03922 $0.03922
Opus 5 $0.01961 $0.01961
Sonnet 5 $0.00784 $0.00784
Haiku 4.5 $0.00392 $0.00392

Measured 2d ago against content hash fbcce5b98f89, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

streamlit specs.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to specs — 4 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.github/instructions/specs.instructions.md · 461 lines

How it starts

The opening of the file, as written. The whole thing — 461 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Streamlit Specs Guide

This directory contains product and tech specs for Streamlit features.

Key files:

  • YYYY-MM-DD-template/product-spec.md — Template for product specs
  • YYYY-MM-DD-template/tech-spec.md — Template for tech specs
  • README.md — Full process documentation

When to Write a Spec

Product spec — focuses on what and why: user-facing problem, proposed API, design mockups, and behavior. Write one when:

  • Proposing a new user-facing feature or significant API change
  • The what and why need alignment before implementation begins
  • Design mockups or UX decisions need sign-off

Tech spec — focuses on how: internal architecture, proto changes, frontend/backend design, state management, and alternatives considered. Write one when:

  • The feature is non-user-facing but architecturally significant
  • The how needs alignment before implementation (e.g., proto design, state management)
  • Multiple implementation paths exist with meaningful trade-offs to document

Does not require a spec:

  • Bug fixes, DevOps improvements, small non-controversial enhancements

A single spec directory can contain both a product-spec.md and a tech-spec.md if the feature warrants both. The directory can also include other assets relevant to the spec (e.g., design mockups, diagrams, supporting documents).

Creating a Spec

  1. Copy specs/YYYY-MM-DD-template/specs/YYYY-MM-DD-feature-name/
  2. Fill in product-spec.md and/or tech-spec.md following the template
  3. Create PR titled [spec] Feature name (keep in Draft until ready for review)

Spec Guidelines

Problem First, Solution Second

Never start with what you want to build. Start with why:

  • Link GitHub issues
  • Show concrete user pain points and current workarounds
  • Include use cases

Present Options, Not Edicts

For non-trivial APIs, show 2-3 options with tradeoffs:

Read the full file on GitHub · 461 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 461 lines · 3,922 tokens per session scan A fbcce5b98f89

Subscribe to this mod's changes

streamlit specs.instructions.md is an instructions file published in the GitHub repository streamlit/streamlit (45,655 stars, last pushed today), licensed Apache-2.0. It adds 3,922 tokens to every session, about $0.0196 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to specs, differing in 4 lines, and is treated as a copy.