Commandes

Chaque commande vous demande les valeurs dont elle a besoin lorsqu'elles ne sont pas données en argument. Les options permettent de sauter les questions, et --yes accepte les valeurs par défaut.

aarshi setup

Crée un projet Next.js dans un nouveau dossier. aarshi setup . utilise le dossier courant.

Elle demande les langues (cases à cocher parmi fr, en, es, ja, ko et de), la langue par défaut, l'URL du site, le gestionnaire de paquets, les composants d'interface et les icônes. Chaque question a son option :

OptionÉvite la question sur
--languages fr,en,jales langues
--default-language jala langue par défaut
--site-url https://example.coml'URL du site
--npm, --pnpm, --yarn, --bunle gestionnaire de paquets
--ui shadcn ou --ui base-uiles composants d'interface
--icons lucide ou --icons nonela bibliothèque d'icônes
--agent-feedback, --cache-componentsles options (désactivées sans ces options)
--yes, -ytoutes les questions : les valeurs par défaut sont utilisées

Les réponses sont enregistrées dans aarshi.toml.

aarshi add, pas à pas

Tapez aarshi add sans argument, dans le dossier du projet. Pas besoin de retenir une option : aarshi pose les questions une à une.

  1. Que voulez-vous ajouter ? Un menu propose Section, Page ou Composant personnalisé. Déplacez-vous avec les flèches et validez avec Entrée.
  2. Si vous avez choisi Section, aarshi demande le nom de la section. Seules les lettres minuscules, les chiffres et les tirets sont acceptés : un nom invalide est refusé et la question revient. Ensuite, aarshi demande dans quelle page la mettre. Le menu liste les pages présentes dans views/ ; sa première entrée, + Create a new page, crée une nouvelle page à la place.
  3. Si vous avez choisi Page, aarshi demande le nom de la page, puis crée sa vue, sa route et son entrée dans le plan du site.
  4. Si vous avez choisi Composant personnalisé, aarshi demande le nom et crée un fichier de départ dans components/custom/.
  5. aarshi affiche un message de succès. Les nouveaux fichiers sont déjà reliés au reste du projet ; il ne reste à écrire que les textes, dans les dictionnaires.

Pour une section, aarshi fait trois choses : il crée views/<page>/sections/<section>.tsx, il ajoute la section à la vue, et il ajoute une clé de titre dans chaque dictionnaire (par exemple "about.team.title").

Même résultat, sans menu. Les options évitent le menu : aarshi add -s equipe a-propos ajoute une section, aarshi add -p a-propos une page, aarshi add -c badge un composant. Si vous omettez un nom, aarshi le demande.
CommandeCe qu'elle ajouteFichiers créés ou modifiés
aarshi add -s <section> <page>une section dans une pageviews/<page>/sections/, la vue, les dictionnaires
aarshi add -p <page>une pageviews/<page>/, app/[locale]/<page>/, app/sitemap.ts, les dictionnaires
aarshi add -c <nom>un composant personnalisécomponents/custom/<nom>.tsx

Si la page donnée à add -s n'existe pas, aarshi le signale et demande s'il faut la créer (o/n).

aarshi add-lang

aarshi add-lang de

Ajoute une langue à un projet existant. Sans code, aarshi le demande. Il crée le dictionnaire lib/i18n/dictionaries/de.ts avec des valeurs vides, et met à jour la liste des langues dans lib/i18n/config.ts, lib/i18n/index.ts et aarshi.toml. Remplissez les valeurs vides : d'ici là, aarshi status les signale comme todo.

aarshi icons

aarshi icons
aarshi icons --all

Placez des fichiers .svg dans components/icons/, puis lancez la commande. Elle les liste avec des cases à cocher, et chaque fichier choisi devient un composant React à côté de lui. --all convertit tous les fichiers sans demander. Un composant existant n'est jamais écrasé.

Les attributs prennent leur nom React (class devient className), les styles en ligne deviennent des objets, et les valeurs simples deviennent des classes Tailwind : width et height deviennent size-*, fill="currentColor" devient fill-current.

aarshi docs

aarshi docs

Ouvre cette documentation dans votre navigateur. Les pages sont incluses dans le programme aarshi et réécrites dans un dossier temporaire à chaque appel : elles correspondent donc toujours à votre version d'aarshi. La page s'ouvre en français quand la langue de votre système commence par fr, en anglais sinon.

aarshi remove et aarshi restore

aarshi remove
aarshi remove --all --yes
aarshi restore

aarshi remove liste ce qu'aarshi a ajouté au projet (pages, sections et composants personnalisés) et supprime ceux que vous choisissez, avec des cases à cocher. --all sélectionne tout, et --yes évite la confirmation. La page d'accueil n'est jamais proposée : / en a besoin. Une section d'une page supprimée part avec la page.

Avant de supprimer quoi que ce soit, aarshi copie chaque fichier qu'il va modifier dans .aarshi/removed/. aarshi restore les recopie et oublie la suppression, pour que les fichiers du projet retrouvent leur état d'avant remove. Seule la dernière suppression peut être restaurée. Les fichiers modifiés depuis la suppression sont écrasés.

Gardez .aarshi/ hors de git. aarshi l'ajoute à .gitignore quand le projet en a un.

aarshi status

Lit le projet et signale ce qui manque ou ce qui ne va pas. Il ne modifie rien. Voir Vérifier un projet.