Agent skill

Faasjs Best Practices

by faasjs in faasjs/faasjs

A skill your agent uses when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and…

MITAuto-check passed

Install Faasjs Best Practices

skills CLI
$ npx skills add faasjs/faasjs --skill faasjs-best-practices -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install faasjs/faasjs faasjs-best-practices --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/faasjs/faasjs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/faasjs-best-practices .claude/skills/faasjs-best-practices && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
faasjs-best-practices
GitHub stars
121
Token cost
~741 tokens
SKILL.md length
323 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and…

  • Works in 5 steps: Identify the task area and load the… → Read local repo instructions and… → Keep changes minimal and task-scoped;… → …
  • Working in any FaasJS repo and no narrower FaasJS skill is already selected
  • SKILL.md covers Default Workflow, Load These References, Gotchas and Validation
  • Calls npx

What it does

Faasjs Best Practices is an agent skill from faasjs/faasjs. Use when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and multiple FaasJS subsystems. For focused work, also load the relevant FaasJS skill: faasjs-project-workflow, faasjs-react-ant-design, faasjs-api-jobs, faasjs-pg, faasjs-plugins-runtime, faasjs-utils-data, or faasjs-specs.

Its SKILL.md is about 740 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It works with React, Ant Design and TypeScript. The repository describes itself as: 🚀 FaasJS is an agent-friendly full-stack TypeScript framework for building predictable, type-safe applications with minimal dependencies. The licence is MIT.

When your agent uses it

  • Working in any FaasJS repo and no narrower FaasJS skill is already selected
  • A task spans project conventions
  • Validation gates
  • Security boundaries

Example prompts

  • “/faasjs-best-practices”

Requirements

  • Node.js

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Identify the task area and load the narrowest FaasJS skill that owns it.
  2. Read local repo instructions and relevant tsconfig.json files before choosing imports or paths.
  3. Keep changes minimal and task-scoped; avoid unrelated refactors, speculative fallbacks, and new aliases unless configuration changes with…
  4. Validate external input at boundaries, check auth/tenant/permission scope before data access, and never log secrets.
  5. Before handoff, run vp check --fix && vp test when feasible; if not feasible, record why and run the smallest useful validation.

What it can do on your machine

Read from SKILL.md and the folder at commit 8136384. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npx

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use npx, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Faasjs Best Practices loads about 741 tokens when it runs. Until then it costs about 103 tokens; SKILL.md has 323 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~103
When it runs · the whole SKILL.md, loaded when a task matches
~741

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from faasjs/faasjs at commit 8136384, republished under its MIT licence (© faasjs). 323 words, ~741 tokens.

Download SKILL.mdSave it as .claude/skills/faasjs-best-practices/SKILL.md (or your agent's skills folder).
name
faasjs-best-practices
description
Use when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and multiple FaasJS subsystems. For focused work, also load the relevant FaasJS skill: faasjs-project-workflow, faasjs-react-ant-design, faasjs-api-jobs, faasjs-pg, faasjs-plugins-runtime, faasjs-utils-data, or faasjs-specs.

FaasJS Best Practices

Default Workflow

  1. Identify the task area and load the narrowest FaasJS skill that owns it.
  2. Read local repo instructions and relevant tsconfig.json files before choosing imports or paths.
  3. Keep changes minimal and task-scoped; avoid unrelated refactors, speculative fallbacks, and new aliases unless configuration changes with them.
  4. Validate external input at boundaries, check auth/tenant/permission scope before data access, and never log secrets.
  5. Before handoff, run vp check --fix && vp test when feasible; if not feasible, record why and run the smallest useful validation.

Load These References

  • New project, feature layout, config, CLI, comments, naming, or shared testing: use faasjs-project-workflow.
  • React UI, @faasjs/ant-design, useFaas, forms, tables, drawers, CRUD screens, or React tests: use faasjs-react-ant-design.
  • .api.ts, defineApi, HTTP plugin helpers, middleware, .job.ts, or defineJob: use faasjs-api-jobs.
  • @faasjs/pg, QueryBuilder, table declarations, migrations, or PostgreSQL tests: use faasjs-pg.
  • Business writes that enqueue a job in the same transaction: load both faasjs-pg and faasjs-api-jobs.
  • Plugin lifecycle, injected fields, logger usage, Node bootstrapping, or runtime config loading: use faasjs-plugins-runtime.
  • @faasjs/utils, JSON, YAML, stream helpers, or validation helpers: use faasjs-utils-data.
  • Normative runtime behavior for faas.yaml, routing, HTTP protocol, or plugin contracts: use faasjs-specs.

Gotchas

  • Zod is for external input contracts; keep internal typeof, instanceof, and null checks as control-flow predicates.
  • Keep local TypeScript imports extensionless and prefer configured aliases over deep relative imports.
  • Destructure React hook returns and only the top-level defineApi/defineJob handler context; keep business values visible as params.key.
  • Return values directly unless an intermediate variable documents a non-trivial condition, is reused, or improves readability.
  • Keep generated job paths aligned with runtime discovery, and do not let transaction-scoped clients escape their callbacks.

Validation

  • Use vp check --fix for formatting and linting.
  • Use vp test or vp test <pattern> for tests.
  • Run npx faas types after adding, renaming, moving, or removing .api.ts or .job.ts files.
  • Run npx faasjs-pg migrate or targeted PG checks only when database changes require them and DATABASE_URL is available.

© faasjs, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/faasjs-best-practices of faasjs/faasjs.

Open the folder on GitHubat commit 8136384

Compare with similar skills

Faasjs Best Practices next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Faasjs Best Practices compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Faasjs Best Practices this skillfaasjs/faasjs121—~741Automated safety check: PassMIT
Building With Lobe UIlobehub/lobe-ui2.2k—~2kAutomated safety check: PassMIT
South Admin CRUD Generatorsouthliu/south-admin-react580—~1.7kAutomated safety check: PassMIT
Local Testinglobehub/lobe-ui2.2k—~2.1kAutomated safety check: PassMIT
Admin Template Project Initializersouthliu/south-admin-react580—~519Automated safety check: PassMIT
Using Docs Kitlobehub/lobe-ui2.2k—~2.8kAutomated safety check: PassMIT

Similar skills

  • Building With Lobe UI

    lobehub/lobe-ui

    Build UI with the LobeHub design ecosystem — @lobehub/ui (plus its base-ui, chat, mobile, awesome, brand, mdx, i18n namespaces), @lobehub/icons, @lobehub/charts, @lobehub/fluent-emoji and…

    2.2k GitHub stars~2k tokensUpdated today
    Frontend & DesignAuto-check passed
  • South Admin CRUD Generator

    southliu/south-admin-react

    Generates a full CRUD page - page component, data model and API client - from the south-admin-react project's own VS Code snippet templates.

    580 GitHub stars~1.7k tokensUpdated 19 days ago
    Frontend & DesignAuto-check passed
  • Local Testing

    lobehub/lobe-ui

    Local browser verification for the lobe-ui component library and documentation site.

    2.2k GitHub stars~2.1k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Admin Template Project Initializer

    southliu/south-admin-react

    Removes the south-admin-react template's demo pages, components and menu entries, after a dry-run preview and your confirmation, and cleans up the matching imports.

    580 GitHub stars~519 tokensUpdated 19 days ago
    Frontend & DesignAuto-check passed
  • Using Docs Kit

    lobehub/lobe-ui

    Set up and author a documentation site with @lobehub/docs-kit (the lobedocs CLI, React Router + Vite static docs used by ui.lobehub.com).

    2.2k GitHub stars~2.8k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Frontend

    streamband/hydra-srt

    A skill your agent uses for frontend work in webapp (React/TypeScript, UI implementation, tests, and refactors).

    147 GitHub stars~582 tokensUpdated 22 days ago
    Frontend & DesignAuto-check passed

More from faasjs/faasjs

All 8 skills in this repo
  • Faasjs API Jobs

    faasjs/faasjs

    A skill your agent uses when building or reviewing FaasJS backend APIs and jobs: .api.ts files, defineApi, zod params schemas, HttpError, HTTP helpers, middleware/staticHandler, .job.ts files…

    121 GitHub stars~653 tokensUpdated 1 mo ago
    Auto-check passed
  • Faasjs Pg

    faasjs/faasjs

    A skill your agent uses when working with @faasjs/pg or PostgreSQL in FaasJS: Tables declaration merging, QueryBuilder, select aliases, parameterized sql expressions, raw SQL, numeric/decimal/bigint…

    121 GitHub stars~718 tokensUpdated 1 mo ago
    Auto-check passed
  • A skill your agent uses when building or reviewing FaasJS plugins and runtime infrastructure: Plugin lifecycle hooks including concurrent mount and failed-mount retry behavior, InvokeData mutation…

    121 GitHub stars~500 tokensUpdated 1 mo ago
    Auto-check: notes
  • A skill your agent uses when creating, configuring, reviewing, or onboarding a FaasJS project; working with create-faas-app, vp CLI, TypeScript or Vite config, feature folders, file and naming…

    121 GitHub stars~577 tokensUpdated 1 mo ago
    Auto-check passed
  • A skill your agent uses when building or reviewing FaasJS React UI, especially @faasjs/ant-design pages, useFaas, useFaasStream, faas requests, CRUD screens, Table faasData, Description faasData…

    121 GitHub stars~693 tokensUpdated 1 mo ago
    Auto-check passed
  • Faasjs Specs

    faasjs/faasjs

    A skill your agent uses when implementing, reviewing, or verifying normative FaasJS runtime behavior and compatibility for faas.yaml, staged config discovery and merge order, zero-mapping route…

    121 GitHub stars~444 tokensUpdated 1 mo ago
    Auto-check passed

Questions about Faasjs Best Practices

What does Faasjs Best Practices do?

A skill your agent uses when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and…. Faasjs Best Practices is an agent skill from faasjs/faasjs. Use when working in any FaasJS repo and no narrower FaasJS skill is already selected, or when a task spans project conventions, validation gates, security boundaries, and multiple FaasJS subsystems.

When should I use Faasjs Best Practices?

Faasjs Best Practices fits situations like: working in any FaasJS repo and no narrower FaasJS skill is already selected; A task spans project conventions; validation gates; security boundaries.

How do I install Faasjs Best Practices in Claude Code?

Run `npx skills add faasjs/faasjs --skill faasjs-best-practices -a claude-code`. Or copy the skill folder (skills/faasjs-best-practices in faasjs/faasjs) into .claude/skills/faasjs-best-practices in your project. Claude Code loads it when a task matches its description.

How do I install Faasjs Best Practices in Codex?

Run `npx skills add faasjs/faasjs --skill faasjs-best-practices -a codex`. Or copy the skill folder (skills/faasjs-best-practices in faasjs/faasjs) into .agents/skills/faasjs-best-practices in your project. Codex loads it when a task matches its description.

Can I use Faasjs Best Practices in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add faasjs/faasjs --skill faasjs-best-practices -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/faasjs-best-practices, .gemini/skills/faasjs-best-practices, .github/skills/faasjs-best-practices and .opencode/skills/faasjs-best-practices in your project.

What does Faasjs Best Practices need to run?

Going by SKILL.md and its folder, Faasjs Best Practices needs the command-line tools its instructions call (npx). Our summary lists: Node.js.

Does Faasjs Best Practices access the network?

SKILL.md contains no URLs. Its commands use npx, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Faasjs Best Practices safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Faasjs Best Practices use?

Faasjs Best Practices is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Faasjs Best Practices use?

About 741 tokens (SKILL.md is roughly 3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Faasjs Best Practices?

Skills that share tags, products or a category with Faasjs Best Practices: Building With Lobe UI (lobehub/lobe-ui, 2.2k stars), South Admin CRUD Generator (southliu/south-admin-react, 580 stars), Local Testing (lobehub/lobe-ui, 2.2k stars) and Admin Template Project Initializer (southliu/south-admin-react, 580 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Faasjs Best Practices?

faasjs (a GitHub organization) maintains it in faasjs/faasjs, which has 121 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on September 3, 2026.

Source: faasjs/faasjs on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.