DokuWerkzeuge und Hilfe
Kodiermittel
Ein mit nx new erstelltes Projekt enthält die Regeln, die ein Programmieragent benötigt, um Nexy-Code auf Ihre Weise zu schreiben: die Arbeitsreihenfolge, die Code- und Schreibregeln und eine Fähigkeit pro Thema. Auf dieser Seite erfahren Sie, was Sie erhalten, wohin es geht und wie Sie es auf dem neuesten Stand halten. Die Arbeit an Nexy selbst ist eine andere Aufgabe: Lesen Sie das Stammverzeichnis des Repositorys AGENTS.md.
Was nx new hinzufügt
| Datei | Gelesen von | Hält |
|---|---|---|
AGENTS.md |
Codex, OpenCode | der Stapel des Projekts, die Arbeitsreihenfolge, die Regeln, die Liste der Fähigkeiten |
CLAUDE.md |
Claude Code | eine Zeile, @AGENTS.md, also lesen beide den gleichen Text |
.agents/skills/ |
Codex, OpenCode | die Fähigkeiten |
.claude/skills/ |
Claude Code, OpenCode | die gleichen Fähigkeiten |
AGENTS.md ist kurz und maßgeschneidert. Ein vom Client weitergeleitetes Vue-Projekt lautet „client-routed, Vue, styled with Tailwind“; Einem API-Projekt wird mitgeteilt, dass es keine Ansichten gibt. Es werden nur die passenden Skills kopiert: Ein React-Projekt bekommt nexy-react und keinen Vue-Skill, ein Serverprojekt bekommt die .nexy- und Markdown-Skills, ein API-Projekt bekommt keinen Skill über Ansichten.
Um alles zu überspringen, erstellen Sie das Projekt mit nx new --no-agents.
Die Fähigkeiten
| Geschicklichkeit | Abdeckungen |
|---|---|
nexy-principles |
Arbeitsreihenfolge, Coderegeln, Schreibregeln |
nexy-ux-audit |
Das Erlebnis- und Informationsarchitektur-Audit muss vor jeder Ansicht durchgeführt werden |
nexy-project |
Modi, Ordner, Dateikonventionen, Konfiguration, Befehle |
nexy-file |
.nexy Seiten, Requisiten, Haken, Inseln |
nexy-markdown |
.md und .mdx Inhalt |
nexy-react, nexy-preact, nexy-solid, nexy-vue, nexy-svelte |
Idiomatischer Code für das Client-Framework |
nexy-styling |
Tailwind, UnoCSS oder einfaches CSS und die Design-Tokens |
nexy-backend |
API-Handler, Aktionen, WebSocket, ISR, Middleware |
nexy-modular |
Controller, Module, Einspritzung und Schutzvorrichtungen des modularen Routers |
nexy-security |
Abhängigkeiten, Eingaben, Sitzungen, Autorisierung, Geheimnisse |
nexy-testing |
die Test-First-Schleife und die Tore |
nexy-framework-dev |
Ändern von Nexy selbst und nicht eines mit Nexy erstellten Projekts |
Die Regeln, die sie durchsetzen: Überprüfen Sie die Erfahrung, bevor Sie eine Ansicht erstellen, schreiben Sie zuerst den fehlgeschlagenen Test, eine Funktion führt eine Behandlung durch, eine Klasse trägt eine Absicht, ein Ordner enthält einen Satz verwandter Absichten, keine Emojis, echte SVG-Symbole, einfacher Text für Personen und keine handgeschriebenen DOM-Skripte in React, Vue, Svelte, Solid oder Preact.
Fügen Sie sie einem vorhandenen Projekt hinzu
nx skills
Führen Sie es im Stammverzeichnis des Projekts aus. Es liest nexyconfig.py und package.json, um den Stapel zu finden, kopiert die passenden Fähigkeiten und schreibt AGENTS.md und CLAUDE.md, wenn sie fehlen.
Eine von Ihnen geschriebene Datei wird niemals überschrieben: Eine vorhandene Datei AGENTS.md oder CLAUDE.md wird beibehalten, und der Befehl teilt Ihnen dies mit. Fügen Sie die Fertigkeitsliste manuell zu Ihrer eigenen Datei hinzu, wenn Sie sie dort haben möchten. Eine eigene Fertigkeit in .claude/skills/ oder .agents/skills/ bleibt unberücksichtigt; Nur die Fertigkeiten nexy-* werden aktualisiert.
Führen Sie nx skills erneut aus, nachdem Sie Nexy aktualisiert haben, um die Kopien zu aktualisieren, und übermitteln Sie das Ergebnis, damit das gesamte Team es teilt.
Wie ein Agent sie findet
AGENTS.md(oderCLAUDE.md, das es importiert) wird zu Beginn jeder Sitzung gelesen. Es benennt die Fähigkeiten.- Jeder Skill beginnt mit einem Namen und einer Beschreibung, die angeben, was er abdeckt und wann er geladen werden muss. Der Agent liest diese zuerst und öffnet einen Skill erst, wenn die Aufgabe übereinstimmt.
Die Fertigkeiten folgen dem offenen Agent-Fähigkeitenformat, sodass andere Agenten, die SKILL.md-Ordner lesen, sie auch verwenden können.
Was sie nicht tun
Fähigkeiten sagen einem Agenten, wie er arbeiten soll; Sie machen die Ausgabe nicht korrekt. Bewahren Sie Ihre eigenen Schecks auf:
- Lesen Sie, was der Agent geändert hat.
- Führen Sie
nx check,nx testundnx buildaus. Die Fähigkeiten verlangen dies und verlangen, dass die Ergebnisse gemeldet und nicht zusammengefasst werden. - Überwachen Sie Abhängigkeiten, die der Agent hinzufügt (
nexy-securityerklärt, wie).
Die Beispiele in den Fertigkeiten werden durch Nexys eigene Tests überprüft: Die Importe existieren, die Konfigurationsfelder existieren, die Befehle existieren, die Python-Analysen. Das fängt Abdrift auf, keine Fehleinschätzung.
Karte
Ein Agent antwortet schneller, wenn er weiß, auf welcher Seite sich die Antwort befindet.
| Du brauchst | Lesen |
|---|---|
| das Produkt auf einer Seite | README |
| ein Projekt ausführen | Erste Schritte |
| die URL einer Datei | Weiterleitung |
| dynamische Segmente, Layouts, Fehlerseiten | Seiten |
| der aktuelle Pfad, die Abfrage, die Cookies, die Sitzung | Haken |
| um eine Seite zu bearbeiten | .nexy-Dateien oder Ansichten |
| Markdown oder MDX | Abschlag |
| integrierte HTML-Helfer | Komponenten |
| Rendering-Modus | SSR, CSR, ISR |
| ein WebSocket | Websocket |
| Controller und Module | modular |
| um einen Endpunkt hinzuzufügen | API |
| ein von einer Seite gepostetes Formular | Aktionen |
| warum eine Anfrage fehlgeschlagen ist und welche Seite darauf antwortet | Ausnahmen |
| Übersetzungen | i18n |
| ein Konfigurationsfeld | Konfiguration |
| um die App zu testen | Testen |
| der Client-Build | Frontend |
Projektinvarianten
__nexy__/wird generiert. Bearbeiten Sie es niemals, schreiben Sie es niemals fest. Löschen Sie es, um einen sauberen Build zu erzwingen.- Eine Datei pro URL.
index.nexyundindex.pyfür denselben Pfad ist ein Fehler, keine Prioritätsregel. - Reservierte Namen in
src/routes/:layout.nexy,loading.nexy,errors.nexy,notfound.nexy,dependencies.py,__init__.py. Verwenden Sie sie nicht für Inhalte. .nexyFrontmatter ist Python, das pro Anfrage ausgeführt wird. Keine Nebenwirkungen auf Modulebene: keine Datei-Handles, keine Datenbankverbindungen, keine Netzwerkaufrufe beim Import..pyinsrc/routes/ist ein API-Handler. Methoden sind Funktionsnamen (GET,POST, ...).- Die Konfiguration lebt in
nexyconfig.py, nicht in Umgebungsvariablen und nicht in verstreuten Konstanten. - Autoescaping ist in
.nexy-Vorlagen deaktiviert: Nicht vertrauenswürdige Werte mit| emaskieren.
nx dev # developmentnx build # production buildnx start # production servernx test # pytest, --client adds vitest
Wenn die Dokumente und der Code nicht übereinstimmen, vertrauen Sie dem Code und sagen Sie Folgendes: nexy/core/config.py enthält alle Optionen, nexy/modules/routers/fbrouter/ die Routing-Regeln, nexy/modules/compiler/ wie .nexy Dateien zu Modulen werden.
Nächste Schritte
- CLI:
nx newundnx skills - Dateikonventionen: reservierte Namen und Routing-Regeln
- Glossar: die Wörter, auf denen diese Regeln basieren
- Sicherheit: Die Version legt die Sicherheitsfähigkeitspunkte fest