Ageup CLI

Die Ageup CLI hilft dir dabei, schnell API-Projekte zu erzeugen und TypeScript-Typen aus einer Swagger/OpenAPI-Spezifikation zu generieren.

Voraussetzungen

• Node.js ≥ 18
• .NET SDK (für API-Templates), inkl. installiertem Ageup-Template:

dotnet new install ageup.api.template

Installation

npm install -g @ageup/cli

Danach steht dir der Befehl ageup global zur Verfügung.

Befehle

ageup init

Interaktives Setup für die ageup.json im aktuellen Projekt.

ageup init

Du wirst nach der Swagger-/OpenAPI-URL und dem Ausgabepfad für die generierten Typen gefragt.

Optional kannst du die Swagger-URL direkt angeben:

ageup init --swagger https://api.example.com/openapi.json

ageup generate (alias ageup g)

Generiert TypeScript-Typen auf Basis deiner ageup.json Konfiguration.

ageup generate
# oder
ageup g

Optional mit expliziter URL (überschreibt die Konfiguration):

ageup generate --url https://api.example.com/openapi.json

ageup new

Erzeugt ein neues Projekt basierend auf dem Ageup API Template und unterstützt dich interaktiv bei der Konfiguration.

ageup new

Ablauf:

1. Auswahl des Projekt-Typs (api, react, angular – aktuell wird nur api unterstützt).
2. Eingabe des Projektnamens.
3. Auswahl von Features (DB, Logging, FileStorage/S3, Auth, Permissions, Tenant, Testing).
4. Bei aktivierter Auth / FileStorage werden weitere Werte wie JWT-Secret, S3-Credentials usw. abgefragt.
5. Die CLI:
   • führt den passenden dotnet new ageupapi ... Befehl aus
   • legt im erzeugten Projektordner eine ageup.json an, z.B.:

{
  "type": "api",
  "name": "MyCompany.Api",
  "template": "ageupapi",
  "options": {
    "booleans": {
      "db": true,
      "auth": true,
      "permissions": true
    },
    "texts": {
      "jwt-secret": "..."
    }
  }
}

Troubleshooting

• dotnet new ageupapi nicht gefunden
  Stelle sicher, dass das Template installiert ist:

  dotnet new install ageup.api.template

• ageup wird nicht gefunden
  Prüfe, ob @ageup/cli global installiert ist und dein globales npm bin im PATH liegt.

Lizenz

MIT © Marvin Koch