Créez vos projets Amplitude depuis votre terminal
L'outil officiel en ligne de commande pour gérer vos projets Amplitude. Créez un projet, rédigez ses assets, validez-le et compilez-le, avec de simples commandes à lancer à la main ou depuis un script.
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash Développement précoce : les commandes et leur sortie peuvent changer entre deux versions.
# Créer un projet et s'y placer $ am project init my_game $ cd my_game # Créer un son de pas en boucle $ am asset sound create footstep \ --file audio/step.wav --bus sfx --gain 0.8 --loop # Vérifier chaque asset, puis compiler pour le runtime $ am project validate $ am project build --output dist/
D'un dossier vide aux assets du runtime
Amplitude est piloté par les données : le SDK lit du JSON. La CLI écrit, vérifie et empaquette ce JSON pour vous.
Démarrer un projet
Génère l'arborescence du projet à partir d'un modèle. Le projet est enregistré auprès de la CLI, sauf indication contraire.
am project init my_gameCréer des assets
Sons, collections, effets, switches, événements, soundbanks, atténuations, RTPC, pipelines et bus, avec des invites si vous omettez une valeur.
am asset sound create explosion --file audio/explosion.wav --bus sfxRepérer les erreurs
Vérifie chaque asset, fichier de bus et configuration du moteur selon les schémas du SDK, références comprises, ou un seul type à la fois pendant vos itérations.
am project validate --sounds-onlyLivrer au moteur
Valide, puis écrit les assets prêts pour le runtime dans un dossier de build. Nettoyez-le d'abord, ou arrêtez-vous à la première erreur.
am project build --output dist/ --cleanCe que vous pouvez lancer dès aujourd'hui
Lancez am --help pour la liste complète, ou ajoutez --help à n'importe quelle commande pour des instructions détaillées
am project init [name] --template --no-registerCrée un projet à partir d'un modèle enregistré.
am project register [path] Enregistre un projet existant.
am project unregister <name> --delete-filesDésenregistre un projet et, au choix, supprime ses fichiers.
am project list --favorite --no-favoriteListe tous les projets enregistrés.
am project favorite <name> --set --unsetAjoute ou retire un projet des favoris.
am project info [name] Affiche les détails d'un projet. Utilise le dossier courant si aucun nom n'est donné.
am project validate --sounds-only --rtpc-only --buses-only …Valide chaque asset, fichier de bus et configuration du moteur d'un projet, ou un seul type.
am project build --output --clean --fail-fastCompile les assets du projet pour le runtime.
--json--non-interactive-q, --quiet-v, --verboseConvivial à la main, prévisible dans un script
Omettez une valeur et la CLI vous la demande. Passez --non-interactive et elle échoue au lieu d'afficher une invite.
- Sortie lisible par machine avec
--jsonsur n'importe quelle commande - Codes d'erreur distincts pour les échecs de validation, d'assets, de projets, du SDK et de build
- Les références sont strictes : un asset manquant est une erreur, et la suppression refuse un asset encore utilisé
- Complétion shell pour bash, zsh et fish
# Exploiter les résultats avec vos propres outils $ am project list --json $ am asset sound list --json $ am project validate --json # Ne jamais attendre une invite $ am --non-interactive asset event delete play_music --yes
Encore jeune, en croissance à ciel ouvert
La CLI en est à la version 0.1 et évolue vite. Une interface en terminal est prévue ensuite, pour parcourir et modifier un projet sans quitter le terminal.
Gestion de projet
DISPONIBLE- Cycle de vie des projets : init, register, list, favorite, info
- Cycle de vie des assets : create, list, update, delete, avec vérification des références
- Validation et build des projets
- Modèles de projet, y compris les vôtres
- Sortie JSON et mode non interactif
Interface en terminal
PRÉVUUne vue interactive d'un projet, pilotée au clavier, construite sur les mêmes commandes. Cette esquisse ne montre que l'idée et évoluera.
Obtenez le binaire am
Lancez le script d'installation, téléchargez une version ou compilez depuis les sources.
Script d'installation
LE PLUS RAPIDEUne seule commande installe la CLI. Vous pouvez d'abord lire le script ici : install.sh · install.ps1
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash PS> powershell -NoProfile -Command "iex (irm 'https://cli.amplitudeaudiosdk.com/install.ps1')" Binaires précompilés
Les versions sont publiées sur GitHub pour cinq cibles.
- Linux · x86_64, aarch64
- macOS · Intel, Apple Silicon
- Windows · x86_64
Chaque archive contient am, les complétions shell, le README et la licence, avec une somme de contrôle SHA-256 et une attestation de provenance du build que vous pouvez vérifier avec gh attestation verify.
# Le SDK est requis à la compilation git clone https://github.com/AmplitudeAudio/cli.git git clone https://github.com/AmplitudeAudio/sdk.git export AM_SDK_PATH="$(pwd)/sdk" cd cli && cargo build # Vérifier que la CLI trouve le SDK $ am sdk check # Complétion par tabulation $ am completions zsh > ~/.zfunc/_am
