Aller au contenu

Documentation

Bien démarrer avec Neo.

L’installer, lui parler, le relier à ta messagerie, garder la main sur ce qu’il fait, et le tenir à jour.

Sur cette page
  1. Installer
  2. Premiers pas
  3. Passer à Neo depuis un autre agent
  4. Commandes principales
  5. Consommation et quotas
  6. Passerelle de messagerie
  7. Accords et sécurité
  8. Mettre à jour
  9. Sauvegarder hors du serveur
  10. Désinstaller
  11. Un problème ?

Installer

Une commande, pour ton utilisateur, sans sudo.

curl -fsSL https://neo-agent.fr/install.sh | bash

L’installateur vérifie ton système, télécharge la dernière version, contrôle son empreinte SHA-256 et prépare Python avec uv, à part de celui du système. Il lance ensuite neo setup, sauf si une configuration existe déjà.

Linux

x86_64 ou arm64, sur une distribution courante : Debian, Ubuntu, Fedora, Arch, openSUSE. Les systèmes basés sur musl, comme Alpine, ne sont pas pris en charge. Il faut curl ou wget.

macOS

macOS 12 ou plus récent. Testé sur Apple Silicon ; Intel n’est pas encore confirmé. Rien à installer avant : ni sudo, ni Homebrew, ni les outils de développement d’Apple.

Windows

Windows 10 (version 1809 ou plus récente) ou Windows 11, x64 ou ARM64. Version d’essai : l’installateur natif n’a pas encore été validé sur un vrai PC. Dans PowerShell, sans droits d’administrateur :

irm https://neo-agent.fr/install.ps1 | iex

Il installe Neo dans %LOCALAPPDATA%\Programs\Neo, ajoute neo à ton PATH et, s’il manque, Git pour Windows (le terminal de Neo en a besoin). Tes données vont dans %LOCALAPPDATA%\neo. Tu préfères WSL2 ? wsl --install dans PowerShell (administrateur), puis la commande Linux dans Ubuntu.

Où Neo s’installe

Le programme
~/.local/share/neo (en root : /opt/neo).
La commande
~/.local/bin/neo, ajoutée au PATH de ton shell.
Tes données
~/.neo : configuration, clés, conversations, compétences. Une autre place avec la variable NEO_HOME.

Options de l’installateur

Elles se placent après bash -s --, par exemple :

curl -fsSL https://neo-agent.fr/install.sh | bash -s -- --service
--version X
Installe la version X plutôt que la dernière publiée.
--prefixe DIR
Choisit le dossier d’installation.
--sans-config
Ne lance pas neo setup à la fin.
--service
Installe aussi la passerelle comme service (neo gateway install).
--complet
Ajoute ripgrep, ffmpeg et Node.js avec le gestionnaire de paquets du système. Sur macOS, affiche la commande Homebrew à lancer.
--migrate
Reprend les réglages d’un autre agent juste après l’installation (neo migrate auto, voir plus bas).
--aide
Affiche toutes les options.

Sous Windows, les mêmes options s’écrivent -Version X, -Prefixe DIR, -SansConfig, -Service, -Complet (commandes winget à lancer), -Migrate et -Aide, après la commande PowerShell :

& ([scriptblock]::Create((irm https://neo-agent.fr/install.ps1))) -Service

Lire le script avant de le lancer

curl -fsSL https://neo-agent.fr/install.sh -o install-neo.sh
less install-neo.sh
bash install-neo.sh

Une fois installé, neo --version affiche la version.

Premiers pas

Choisis ton modèle, puis parle à Neo.

Configurer : neo setup

L’assistant te fait choisir un fournisseur de modèle (Anthropic, OpenAI, Gemini, OpenRouter…) ou un modèle local avec Ollama, puis règle le reste : terminal, outils, messagerie. Tu paies ton fournisseur directement.

neo setup

Pour ne refaire qu’une partie : neo setup model, neo setup gateway, neo setup tools. Sur une installation existante, neo setup --quick ne demande que ce qui manque.

Parler à Neo : neo

neo

Écris ta demande et appuie sur Entrée. Neo te dit ce qu’il a compris, délègue à des agents spécialisés quand il le faut, et s’arrête pour te demander ton accord avant toute action sensible.

Dans la conversation, les commandes commencent par une barre oblique :

/help
Toutes les commandes de la conversation.
/new
Nouvelle conversation, sans l’historique.
/model
Changer de modèle.
/skills
Chercher, installer et gérer les compétences.
/undo
Revenir sur ton dernier message.
/quit
Quitter (ou /exit).

Pour reprendre la dernière conversation : neo -c.

Passer à Neo depuis un autre agent

Tes réglages, ta mémoire et tes compétences te suivent, sans rien effacer.

Tu utilises déjà OpenClaw (et ses anciens noms Clawdbot et Moltbot), Claude Code, Codex ou un autre agent compatible ? Neo reprend ce que tu y as réglé. Une commande installe Neo puis lance la reprise :

curl -fsSL https://neo-agent.fr/install.sh | bash -s -- --migrate

Sous Windows, dans PowerShell :

& ([scriptblock]::Create((irm https://neo-agent.fr/install.ps1))) -Migrate

Neo est déjà installé ? Lance simplement :

neo migrate auto

Neo cherche les agents installés sur ta machine, te montre ce qu’il va reprendre et attend ton accord avant d’écrire quoi que ce soit. neo migrate auto --dry-run affiche ce résumé sans rien modifier. Un agent déjà repris n’est plus proposé. Sans terminal (avec --yes, ou l’installateur lancé sans console), Neo reprend le seul agent de messagerie qu’il trouve, plus Claude Code et Codex ; s’il en trouve plusieurs, il ne change rien et t’indique les commandes neo migrate <agent> à lancer.

Ce que Neo reprend

Selon l’agent :

Réglages
Modèle, fournisseur, outils et accords.
Mémoire
Ce que ton agent sait de toi, sa personnalité et ses notes.
Compétences
Celles que tu as installées ou écrites.
Clés
Tes clés de fournisseur et tes jetons, si tu es d’accord (--no-secrets pour les laisser de côté).
Messageries
Telegram, WhatsApp, Discord, Slack, Signal… Le WhatsApp d’OpenClaw ne se reprend pas tel quel : tu le relies de nouveau à Neo.
Tâches planifiées
Quand ton agent en avait. Celles d’OpenClaw sont listées dans le rapport, pas importées : tu les recrées dans Neo.

Neo a déjà une configuration ? Elle n’est jamais remplacée sans ton accord, et toujours sauvegardée avant.

Rien n’est effacé

Neo copie, il ne déplace rien : le dossier de ton ancien agent reste tel quel. Un rapport garde la trace de tout ce qui a été repris.

Si ton ancien agent tourne en arrière-plan (service, tâche planifiée), Neo l’arrête et le désactive avant de prendre le relais : sinon, les deux répondraient aux mêmes messages. Pour revenir en arrière :

neo migrate undo

Neo arrête sa passerelle, puis remet ton ancien agent en route et lui rend sa session WhatsApp (sa copie précédente est gardée dans le rapport). WhatsApp peut alors te demander de relier l’appareil de nouveau. Aucune donnée n’est supprimée, ni d’un côté ni de l’autre.

Si la passerelle de Neo ne démarre pas après la reprise, Neo fait ce retour arrière tout seul. Avec --service (ou -Service), l’installateur n’installe la passerelle de Neo que si la reprise a abouti ; sinon, lance neo gateway install une fois ton ancien agent arrêté. neo migrate auto --help liste toutes les options.

Commandes principales

Dans ton terminal. neo --help les liste toutes.

  • neo

    Ouvre une conversation.

  • neo -c

    Reprend la dernière conversation.

  • neo setup

    Relance l’assistant de configuration.

  • neo model

    Choisit le fournisseur et le modèle par défaut.

  • neo status

    Montre l’état de tous les composants.

  • neo doctor

    Vérifie la configuration et les dépendances. Avec --fix, tente de corriger.

  • neo config edit

    Ouvre la configuration dans ton éditeur (neo config show pour la lire).

  • neo sessions list

    Liste les conversations récentes.

  • neo logs

    Affiche le journal. neo logs errors pour les erreurs, -f pour suivre en direct.

  • neo backup

    Sauvegarde ~/.neo dans une archive zip (neo import la restaure).

  • neo backup push

    Envoie une sauvegarde chiffrée ailleurs que sur la machine (voir plus bas).

  • neo usage --all

    Montre ta consommation et ce qu’il te reste, par fournisseur.

  • neo update

    Met Neo à jour.

Consommation et quotas

Ce que tu as dépensé, et ce qu’il te reste, fournisseur par fournisseur.

neo usage --all

Neo interroge chaque fournisseur dont une clé est configurée (dans ~/.neo/.env ou avec neo auth add), en parallèle et avec un délai court : un service lent ou en panne n’empêche pas les autres de répondre. Aucune clé n’est jamais affichée.

Modèles
DeepSeek et Kimi (solde), OpenRouter (plafond et dépense de la clé), Codex et Claude connecté par OAuth (fenêtres de limites).
Voix
ElevenLabs : caractères utilisés sur ton forfait et date de remise à zéro.
Recherche web
Tavily, Firecrawl et SerpApi : crédits ou recherches restants.
OSINT
Shodan, Hunter.io, Intelligence X, VirusTotal, Have I Been Pwned.

OpenAI, Gemini, Groq, Mistral et Jev (TypeSafe) n’exposent pas leur solde avec une clé ordinaire : Neo te le dit au lieu d’inventer un chiffre.

Ta consommation, vue par Neo

Sous les fournisseurs, Neo additionne ce qu’il a lui-même consommé sur les 30 derniers jours : jetons en entrée, en sortie et en cache, et coût estimé, par fournisseur et par modèle, ainsi que les caractères envoyés à la synthèse vocale. --days 7 change la période, --no-local la retire. Le coût est une estimation, pas une facture.

Pour un script ou Neo Desktop

neo usage --all --json

Un seul document JSON, versionné par schema_version. Neo Desktop lit le même par l’API de Neo (GET /api/usage, avec ta clé d’API), qui le garde 60 secondes en mémoire. neo usage seul, sans --all, montre toujours les limites du fournisseur de ton modèle.

Un service qui n’est pas dans la liste

Déclare son point d’accès dans config.yaml. La clé reste dans ~/.neo/.env : tu ne donnes que le nom de la variable, et les chemins des champs dans la réponse JSON.

~/.neo/config.yaml
usage:
  custom:
    - id: jev
      label: Jev (TypeSafe)
      url: https://exemple.com/v1/usage
      key_env: JEV_API_KEY
      unit: credits
      fields: {used: data.used, limit: data.limit, resets_at: data.reset}

Passerelle de messagerie

Écris à Neo depuis ton téléphone ; il répond au même endroit.

La passerelle relie Neo à Telegram, WhatsApp, Signal, Slack, Discord, Matrix, Microsoft Teams, l’e-mail ou les SMS. Deux commandes suffisent.

  1. Choisis et configure tes messageries :

    neo gateway setup
  2. Installe la passerelle comme service, pour qu’elle tourne en arrière-plan et reste joignable (systemd sous Linux, launchd sous macOS) :

    neo gateway install

L’option --service de l’installateur fait la même chose dès l’installation. Sous Linux, neo gateway install --system installe un service système, lancé au démarrage de la machine. Sous Windows, c’est une tâche planifiée à l’ouverture de session (ou le dossier Démarrage, sans droits d’administrateur).

La piloter

  • neo gateway status

    Dit si la passerelle tourne.

  • neo gateway restart

    La redémarre, par exemple après une mise à jour.

  • neo gateway stop

    L’arrête (neo gateway start pour la relancer).

  • neo gateway uninstall

    Retire le service.

  • neo gateway run

    La lance au premier plan, sans service : conseillé dans WSL ou Docker.

Accords et sécurité

Neo ne fait rien de sensible sans ton accord.

Avant une commande sensible (supprimer un dossier, forcer l’envoi de code, exécuter un script téléchargé…), Neo s’arrête, montre la commande et attend ta réponse :

Une fois
Il lance cette commande, cette fois seulement.
Pour la session
Il ne redemande plus pour ce type de commande jusqu’à la fin de la conversation.
Toujours
La commande rejoint ta liste d’autorisation permanente (command_allowlist dans la configuration).
Refuser
Il ne fait rien, et te le dit.

Sans réponse au bout de 60 secondes, la commande est refusée (réglage approvals.timeout). Certaines commandes sont sur une liste de blocage : elles ne peuvent jamais être autorisées.

Depuis ta messagerie, réponds /approve (ou /approve session, /approve always) pour autoriser, /deny pour refuser.

Choisir le niveau de contrôle

Le réglage approvals.mode de ~/.neo/config.yaml (neo config edit) :

manual
Par défaut : Neo demande toujours.
smart
Un modèle auxiliaire autorise seul les commandes à faible risque et te demande pour les autres.
off
Neo ne demande plus rien. Comme neo --yolo ou /yolo dans la conversation.

Dans les tâches planifiées, personne n’est là pour répondre : une commande sensible y est bloquée (réglage approvals.cron_mode, deny par défaut).

Mettre à jour

Une commande, et la version précédente reste là.

neo update

Neo compare ta version à la dernière publiée, puis relance l’installateur après ton accord. neo update --check vérifie sans rien installer ; neo update --force réinstalle la même version.

Relancer la commande d’installation revient au même. Si la passerelle tourne en service, redémarre-⁠la ensuite :

neo gateway restart

Revenir en arrière

L’installateur garde la version précédente. Pour y revenir, indique son numéro :

curl -fsSL https://neo-agent.fr/install.sh | bash -s -- --version 0.2.4

Sous Windows :

& ([scriptblock]::Create((irm https://neo-agent.fr/install.ps1))) -Version 0.2.4

Au lancement, Neo regarde au plus une fois toutes les 6 heures si une nouvelle version est publiée, et te le signale sans rien installer. Le réglage update.mode choisit ce comportement : manuel (aucune vérification automatique), verifier (par défaut) ou auto (au début d’une session, Neo installe lui-même la nouvelle version, la précédente reste là) :

neo config set update.mode auto

NEO_NO_UPDATE_CHECK=1 désactive toute vérification automatique ; neo update --check reste toujours possible.

Toutes les versions et leurs empreintes

Sauvegarder hors du serveur

Une copie chiffrée de Neo, régulière, sur un autre disque ou une autre machine.

neo backup push fait la même sauvegarde complète que neo backup (configuration, clés, mémoire, conversations, compétences), la chiffre, puis l’envoie à la destination de ton choix. Choisis-⁠la une fois :

neo backup remote set sftp://moi@nas.local/~/neo-sauvegardes
/chemin/absolu
Un dossier sur un disque externe ou un partage réseau monté (Windows : D:\Sauvegardes\Neo). Neo refuse un dossier dans ~/.neo et te prévient si le dossier est sur le même disque.
sftp://utilisateur@hôte[:port]/chemin
Une autre machine, par les commandes ssh et sftp de ton système, avec une clé SSH (jamais de mot de passe). /~/dossier part de ton dossier personnel distant. Les réglages de ~/.ssh/config s’appliquent.
rclone:remote:chemin
S3, Google Drive, Dropbox et une soixantaine d’autres, si rclone (https://rclone.org/) est installé et le remote configuré (rclone config).

Vérifie-⁠la, puis envoie une première sauvegarde. Lance le test dans un terminal la première fois : pour SFTP, il enregistre la clé de la machine distante.

neo backup remote test
neo backup push

La phrase de passe

Neo te la demande, masquée, à chaque envoi depuis un terminal : 12 caractères au moins, une suite de mots est plus simple à retenir. Elle peut aussi venir de la variable NEO_BACKUP_PASSPHRASE (dans l’environnement ou dans ~/.neo/.env). Elle n’est jamais écrite dans les journaux ni transmise aux outils de l’agent.

Chaque jour, tout seul

neo backup schedule daily

Neo confie l’envoi au planificateur de ton système : timer systemd (ou crontab) sous Linux, launchd sur macOS, tâche planifiée sous Windows. Il tourne même quand la passerelle est arrêtée et, sauf avec crontab, rattrape un passage manqué. weekly pour chaque dimanche, --time 04:00 pour changer l’heure (3 h 30 par défaut), off pour arrêter. La phrase est alors enregistrée dans ~/.neo/.env, lisible par toi seul.

Neo garde les 7 dernières sauvegardes à destination et efface les plus anciennes. Pour en garder plus (0 les garde toutes) :

neo config set backup.keep 14

Savoir où tu en es

neo backup status

Destination, planification, dernière réussite et dernier échec, avec leur cause (--json pour un script). Si un envoi planifié échoue, Neo te le signale aussi à l’ouverture d’une conversation.

Restaurer

neo backup restore

Neo récupère la dernière sauvegarde (ou celle que tu nommes, ou un fichier .neobak local), la déchiffre et vérifie chaque bloc avant de toucher à quoi que ce soit : une mauvaise phrase ou un fichier abîmé s’arrête là. Il te montre ce qu’il va restaurer, te demande confirmation, fait une copie de sécurité de tes données actuelles dans ~/.neo/backups, puis restaure comme neo import.

Désinstaller

L’installateur sait aussi tout retirer.

curl -fsSL https://neo-agent.fr/install.sh | bash -s -- --desinstaller

Il retire le service de la passerelle, la commande neo, le programme et la ligne ajoutée au PATH. Tes données restent dans ~/.neo, prêtes pour une réinstallation.

Sous Windows, dans PowerShell (données conservées dans %LOCALAPPDATA%\neo) :

& ([scriptblock]::Create((irm https://neo-agent.fr/install.ps1))) -Desinstaller

Tout effacer

curl -fsSL https://neo-agent.fr/install.sh | bash -s -- --desinstaller --purger
& ([scriptblock]::Create((irm https://neo-agent.fr/install.ps1))) -Desinstaller -Purger

Un problème ?

Une vérification d’abord, puis dis-⁠le-⁠nous : chaque rapport aide à corriger Neo.

neo doctor

Elle vérifie la configuration et les dépendances ; neo doctor --fix tente de corriger ce qui peut l’être. neo logs errors montre les dernières erreurs.

L’installation échoue, ou Neo ne se lance pas ? Copie le texte affiché, de la commande jusqu’à l’erreur, et envoie-⁠le avec quelques mots : pas besoin de capture d’écran.

Signaler un problème