Démarrage rapide
Installez Apothem, rédigez un profil, matérialisez votre premier environnement et vérifiez-le — une visite à copier-coller avec la sortie attendue.
Voici le chemin rapide de zéro jusqu'à une configuration d'environnement vérifiée : installer, rédiger le profil partagé, matérialiser la configuration native d'un outil, la confirmer et effectuer votre première modification. Chaque commande est réelle et peut être copiée-collée telle quelle, et chaque étape montre ce qu'affiche une exécution propre. L'installation elle-même se termine en moins de deux minutes ; éditer le profil est la seule partie qui prend autant de temps que vous le souhaitez.
À la fin, vous disposerez d'une configuration d'environnement fonctionnelle générée à partir d'un profil que vous avez rédigé — et vous connaîtrez l'unique commande qui répercute une modification du profil vers un seul outil ou vers tous.
Vous voulez la version lente et commentée ?
Le tutoriel de prise en main parcourt le même terrain avec davantage d'explications sur chaque étape et sur son importance. Cette page est la visite concise, centrée sur la sortie.
Vous utiliserez Claude Code comme environnement d'exemple — c'est celui par défaut de l'installateur. Remplacez le nom de l'adaptateur à n'importe quelle étape pour cibler un autre outil ; la liste des environnements contient tous les noms pris en charge.
1. Installer Apothem
Apothem est distribué comme un runtime autonome — le moteur s'exécute
directement depuis son arborescence source avec des dépendances vendorisées.
Une seule commande récupère le code source, place le moteur et matérialise
votre premier environnement. Elle vérifie d'abord la publication signée ;
importez donc la clé de signature du mainteneur une seule fois avant la première
installation, puis vérifiez que l'empreinte affiche 5C89 98F9 F241 7204 45D3 F28B 7039 6FED 9C63 4163 :
curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import
gpg --fingerprint 70396FED9C634163& "$env:ProgramFiles\Git\bin\bash.exe" -c 'curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import && gpg --fingerprint 70396FED9C634163'Exécutez ensuite l'installateur :
curl -fsSL https://apothem.ahmedgad.com/install.sh | bashirm https://apothem.ahmedgad.com/install.ps1 | iexL'installateur requiert un Python 3.10+ système, ainsi que git et gpg pour la
forme réseau. Il vérifie les prérequis et place le moteur sous ~/.apothem.
Lorsque click ou rich est absent, il installe le paquet avec votre
confirmation, ou avec --yes (-Yes sous PowerShell) ou
APOTHEM_AUTO_INSTALL_DEPS=1, et s'arrête sinon avec la commande pip à exécuter
(voir Prérequis en un coup d'œil).
Une fois terminé, il affiche une bannière d'étapes suivantes ; sous POSIX,
lorsque le répertoire du shim figure déjà dans PATH, la bannière ressemble à
ceci :
Installation complete.
The 'apothem' command is on your PATH.
Recommended first step — the guided setup (profile -> preview -> install):
apothem quickstartPremière exécution sans profil
Si vous n'avez pas encore de profil, l'installateur copie le profil d'exemple
vers ~/.config/apothem/profile.yaml et poursuit : il matérialise votre
premier environnement et le vérifie au cours de la même exécution. Les champs
d'identité de l'exemple sont des espaces réservés ; l'installation affiche
donc une remarque. Faites du profil le vôtre à l'Étape 2, puis appliquez-le
avec apothem update --harness <name> comme à l'Étape 5.
La commande `apothem`
L'installateur écrit un shim apothem dans $HOME/.local/bin (POSIX) ou
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) et ne modifie jamais votre
PATH. Une fois ce répertoire dans PATH, vous exécutez directement le moteur
sous la forme apothem <command>. S'il n'est pas encore dans PATH,
la bannière affiche un repli autonome —
PYTHONPATH="$HOME/.apothem/src" python3 -m apothem <command> — qui ne
nécessite aucun shim ; faites précéder chaque commande du préfixe exact
affiché par votre bannière.
Le guide d'installation couvre les autres voies
d'installation — le plugin Claude Code
(/plugin marketplace add ahmed-g-gad/apothem puis
/plugin install apothem@apothem) ; les extensions de la famille VS Code et
les autres extensions natives des outils ; et la forme npx à la demande
(npx @ahmed-g-gad/apothem <command>) — ainsi que les options par variables
d'environnement.
2. Créer le profil partagé
apothem profile init écrit le plus petit profil valide selon le schéma dans
~/.config/apothem/profile.yaml. Si un profil s'y trouve déjà, comme lorsque
l'installateur de l'Étape 1 a copié l'exemple, init s'arrête avec une erreur et
laisse le fichier inchangé ; passez --force pour l'écraser, ou conservez le
fichier et modifiez-le comme indiqué ci-dessous. Passez --profile PATH
lorsque vous conservez ailleurs un profil propre à un projet ou à la CI.
apothem profile init
apothem profile show --jsonLe squelette utilise des données d'identité fictives servant d'espaces réservés
et peut être édité sans risque avant que vous n'installiez la moindre sortie
d'environnement. show --json le relit et affiche le profil validé, avec
chaque valeur par défaut renseignée, en commençant par schema_version. La
commande l'affiche sur une seule ligne ; il est développé ici :
{
"schema_version": 1,
"identity": {
"name": "Example User",
"role": "senior software engineer",
"email": "[email protected]",
"github": "example-user"
},
"preferences": {
"language": "python",
"style": "concise"
},
"rules": [],
"seriousness": "PERSONAL_USE",
"enforcement": {
"sprints": false,
"agent_teams": false,
"multitasking": false,
"continuous_execution": false,
"learning_loop": false
},
"mcp_servers": {},
"agent_mcp_servers": {},
"harnesses": {},
"exclude_harnesses": [],
"workspace": {
"directory_name": ".apothem",
"scope": "project-local"
}
}C'est aussi ici qu'une modification malformée apparaît : si le YAML n'est pas
valide, show le signale à ce stade, avant qu'aucune configuration
d'environnement ne soit écrite. Faites du profil le vôtre avec
apothem profile edit (qui l'ouvre dans votre éditeur) ou définissez une seule
clé sur place :
apothem profile set identity.name "Your Name"3. Installer les adaptateurs d'environnement
Matérialisez l'adaptateur de votre environnement principal. Cette commande lit votre profil et écrit la configuration native de cet outil :
apothem install --harness claude-code✓ Installed claude-code -> /home/you/.claude/settings.jsonLes adaptateurs à portée projet écrivent leur fichier de règles à l'intérieur
d'un projet, et ont donc besoin d'un --project PATH ; sept d'entre eux
écrivent aussi des skills et des règles partagées dans des dossiers de votre
répertoire personnel, et --project ne change pas l'emplacement de ceux-ci.
Prévisualisez n'importe quelle installation sans écrire de fichiers avec
--dry-run :
apothem install --harness cursor --project . --dry-run
apothem install --harness cursor --project .Installez d'un coup l'ensemble complet adossé au registre avec --harness all.
Comme cette sélection écrit à la fois des fichiers à portée projet et à portée
utilisateur, la commande affiche les cibles concrètes regroupées par
emplacement. Dans un terminal interactif, elle demande confirmation avant
d'écrire en dehors de la racine du projet. Une exécution sans terminal, une
exécution avec --yes ou une exécution avec --format json écrit sans
demander ; --dry-run n'écrit rien. Exécutez l'ensemble complet avec :
apothem install --harness all --project .Consultez la liste complète des environnements pour tous les noms pris en charge, et la référence d'installation pour l'ensemble complet des options.
4. Vérifier
Matérialiser n'est que la moitié du travail — verify confirme que les fichiers
de configuration attendus de l'environnement sont bien en place et valides :
apothem verify --harness claude-code✓ claude-code is verified at /home/you/.claude/settings.jsonverify se termine avec un code non nul si une cible gérée est absente, si un
fichier géré est vide, ou si une configuration JSON ou YAML ne s'analyse pas.
Ajoutez --profile PATH pour que la commande échoue aussi lorsqu'un fichier
installé diffère de ce profil, ce qui fait de verify un contrôle de dérive ;
sans cette option, une configuration périmée passe quand même la vérification.
Ce code de sortie non nul permet à verify de servir de portail dans un script
de configuration. Pour un contrôle de santé de toute la machine sur chaque
adaptateur enregistré, exécutez :
apothem doctordoctor vérifie chaque environnement installé : celui-ci doit passer la
vérification, et chaque commande de hook que son installation a enregistrée
doit démarrer. Un environnement que vous n'avez pas installé est listé mais ne
constitue pas un échec ; doctor se termine donc avec le code 0 lorsqu'aucune
vérification n'échoue, même si un seul environnement est installé.
5. Votre première exécution
Ouvrez l'environnement que vous venez de configurer — Claude Code, dans cet exemple — et démarrez une session dans n'importe quel projet. Le profil que vous avez mis en place à l'Étape 2 fait désormais partie du comportement de cet outil. C'est la première exécution fonctionnelle : un profil qui façonne une session réelle.
Lorsque vous modifiez le profil par la suite, réappliquez-le sans réinstaller :
apothem update --harness claude-codeNommez un autre adaptateur pour réappliquer le profil à cet outil (ajoutez
--project PATH pour un adaptateur à portée projet), ou passez
--harness all --project . pour le réappliquer à chaque environnement pris en
charge.
Étapes suivantes
- Ajouter d'autres environnements — répétez l'Étape 3 pour chaque outil.
- Écrire votre première règle — l'unité dont hérite chaque environnement.
- Rédiger un plan — pilotez une mission complète à travers le pipeline de planification déterministe.
- Référence de la CLI — chaque commande, option et code de sortie.
Installation
Aperçu de l'installation d'Apothem — huit canaux d'installation, chacun avec ses prérequis, une commande prête à copier et une étape de vérification : le plugin Claude Code, le shim npm, les installateurs en une seule étape, l'extension de la famille VS Code, les trois extensions d'amorçage en ligne de commande et le moteur direct.
Concepts
Glossaire définissant les profils partagés, les adaptateurs d'environnement, les règles, les hooks, les portails de conformité, les skills et les travailleurs délégués dans Apothem.