Aller au contenu
NouveauDécouvrir comment

Démarrage rapide de la CLI FirstSales

Installez la CLI FirstSales, authentifiez-vous avec une clé API et exécutez vos premières commandes sans risque — whoami, découverte org/workspace, dry-run et idempotence.

Tutoriels
Développeur & CLI
min de lecture
8 min
étapes
7 · Avancé

  1. Installez le CLI

    Le CLI FirstSales est un package npm. Installez-le globalement pour obtenir le binaire firstsales :

    npm install -g @firstsales.io/cli
firstsales --version

  2. Authentifiez-vous

    Créez une clé Developer API dans Settings → API, puis fournissez au CLI la clé et l'URL de base. La méthode la plus propre est d'utiliser des variables d'environnement :

    export FIRSTSALES_API_KEY="fs-key-..."
export FIRSTSALES_BASE_URL="https://api.app.firstsales.io"

  3. Vérifiez avec whoami et doctor

    Avant toute chose, confirmez que la clé pointe vers le bon contexte. whoami affiche votre utilisateur, votre org et votre workspace ; doctor vérifie votre configuration :

    firstsales whoami --json
firstsales doctor

  4. Comprenez les flags globaux

    Chaque commande partage les mêmes flags (apprenez-les une bonne fois pour toutes :

    • --org <id> / --workspace <id>) portée ciblée (la plupart des commandes ont besoin des deux).
    • --json (par défaut) / --pretty (format de sortie.
    • --data '<json>' / --data-file <path>) corps de la requête.
    • --idempotency-key <key> (nouvelles tentatives sûres sur les créations.
    • --dry-run) prévisualise la requête sans l'envoyer.
    • --confirm (requis pour toute commande destructrice (suppression).
    • --api-key / --base-url / --profile) surcharge l'authentification par appel.

  5. Découvrez votre org et votre workspace

    La plupart des commandes sont limitées à une org et un workspace. Listez-les, puis réutilisez les IDs :

    firstsales organizations list
firstsales workspaces list --org ORG_ID
firstsales campaigns list --org ORG_ID --workspace WS_ID

  6. Effectuez une première mutation en toute sécurité

    Suivez la boucle d'or : inspecter d'abord, muter délibérément, vérifier ensuite. Prévisualisez avec --dry-run, puis créez avec une clé d'idempotence, puis relisez pour confirmer :

    # Preview : no write happens
firstsales contacts create --org ORG_ID --workspace WS_ID \
  --data '{"email":"[email protected]","first_name":"Jane"}' --dry-run

# Create for real, idempotently
firstsales contacts create --org ORG_ID --workspace WS_ID \
  --data '{"email":"[email protected]","first_name":"Jane"}' \
  --idempotency-key jane-acme-2026-01

# Verify
firstsales contacts list --org ORG_ID --workspace WS_ID

  7. Supprimez de façon délibérée

    Les commandes destructrices refusent de s'exécuter sans --confirm : il s'agit d'une friction intentionnelle pour qu'un agent ou une commande mal saisie ne puisse pas effacer des données par accident :

    firstsales contacts delete --org ORG_ID --workspace WS_ID \
  --contact CONTACT_ID --confirm

Astuces de pro

  • Inspecter d'abord, muter délibérément, vérifier ensuite

    Le CLI est construit autour de cette boucle. Listez avant de modifier, testez le changement avec --dry-run, exécutez-le, puis relisez pour confirmer. C'est plus lent à taper, mais bien moins coûteux que d'annuler une mauvaise écriture.

  • --json est pour les machines, --pretty pour vous

    La sortie est en JSON compact par défaut afin que les scripts et les agents puissent l'analyser. Ajoutez --pretty quand un humain lit la sortie, mais gardez --json dans les pipelines.

  • Ne renvoyez jamais votre clé en clair

    Passez l'authentification via FIRSTSALES_API_KEY ou un profil, pas en ligne où elle finirait dans l'historique du shell ou les logs. Le CLI n'affiche jamais les clés brutes : ne défaites pas cette protection en faisant un echo de la variable d'environnement.

  • Les clés d'idempotence sont une assurance gratuite

    Toute création susceptible d'être retentée devrait porter --idempotency-key. Une commande rejouée devient un no-op au lieu d'un doublon.

Questions fréquentes

Comment installer le CLI ?

npm install -g @firstsales.io/cli, qui vous donne le binaire firstsales. Il correspond directement à l'API Developer publique /api/v1.

Comment fonctionne l'authentification ?

Définissez FIRSTSALES_API_KEY (et éventuellement FIRSTSALES_BASE_URL) dans votre environnement, ou passez --api-key / --base-url à chaque commande. Vérifiez avec firstsales whoami --json.

Pourquoi les commandes ont-elles besoin de --org et --workspace ?

Les ressources sont rattachées à une organisation et un workspace. Listez-les avec organizations list et workspaces list --org ORG_ID, puis passez les deux IDs sur les commandes concernées.

Que fait --dry-run ?

Il affiche la requête que le CLI enverrait sans réellement l'envoyer : vous pouvez ainsi confirmer le corps et la cible avant une mutation réelle.

Pourquoi ma suppression ne s'exécute-t-elle pas ?

Les commandes destructrices exigent le flag --confirm par conception. Ajoutez --confirm une fois que vous êtes sûr : c'est le garde-fou qui empêche les suppressions accidentelles.

Le CLI est-il différent de l'API ?

C'est une fine couche au-dessus des mêmes endpoints publics /api/v1. Le CLI ajoute du confort (authentification centralisée, JSON stable, gestion de l'idempotence et confirmation des opérations destructrices) afin que les agents et les scripts n'aient pas à les réimplémenter.

Puis-je garder plusieurs comptes configurés ?

Oui : utilisez --profile <name> pour charger un profil local enregistré, ou surchargez --api-key/--base-url par commande pour basculer entre orgs ou environnements.

Développeur & CLI

Une prospection qui continue quand vous vous déconnectez.Leads, emails, relances et réponses, gérés.

Connectez des boîtes illimitées et laissez les agents IA trouver les leads, écrire chaque email et relancer. Ou envoyez vos propres modèles en mode manuel. À partir de $29/mois.

Démarrez votre essai à $1 Voir les tarifs

$1 pour 3 jours · Annulez quand vous voulez · Sans engagement

Installer avec l'IA

Votre agent de code installe la CLI et les skills FirstSales pour vous.

Prompt pour Claude Code

I'm setting up FirstSales (https://firstsales.io), an AI outbound sales platform: campaigns, contacts, a reply inbox, deliverability and lead signals. Help me get my workspace sending real, good emails end to end, from Claude Code.

Read these first so you know how FirstSales works:
- Developer docs and API: https://developer.firstsales.io
- CLI: https://www.npmjs.com/package/@firstsales.io/cli
- Skills for coding agents: https://github.com/firstsalesio/firstsales-skills (read README.md and GUIDE.md)

Setup
1. Install the CLI: npm install -g @firstsales.io/cli
2. Install the FirstSales skills:
   claude plugin marketplace add firstsalesio/firstsales-skills
   claude plugin install firstsales@firstsales
3. Ask me if I already have a FirstSales account. If not, send me to https://app.firstsales.io to sign up.
4. Ask me to create an API key under Settings → API → API Keys, with only the scopes we need.
   Never ask me to paste the key into this chat. Tell me to run this in my own terminal, so the key stays hidden:
   read -rs FS_KEY && firstsales auth login --api-key "$FS_KEY"; unset FS_KEY
5. Run `firstsales whoami` and tell me which workspace and organisation we are connected to.

Then ask me about my business: what I sell, who I sell to (roles, company size, countries), my best customers, and what I use today for outbound (tools, lists, mailboxes). Walk me through:
1. Teaching FirstSales my business: website, offer, proof points and case studies in the knowledge base, so the AI writes like someone who knows the product.
2. Connecting my sending mailboxes and checking my sending domain: SPF, DKIM, DMARC and warm-up. If anything is unhealthy, tell me the exact DNS record to add.
3. Bringing in contacts: import my CSV or CRM export into a clean list, remove duplicates and bad emails, and block domains I must never email (customers, competitors, my own).
4. Building my first campaign: the right list, senders, steps and timing. Write the sequence with me, show me the drafts, and do not launch until I say yes.
5. Setting up Signals if it fits: find people engaging with LinkedIn posts about topics my buyers care about, and turn them into leads.
6. Inviting my team and giving each person the right access.

Once campaigns run, show me how to work the reply inbox from here: which replies need an answer, draft responses in my voice, and move good conversations into deals. If I use Cal.com, connect it so follow-ups can offer my booking link (not the first email).

Throughout, as you learn about my business, proactively suggest and help create:
- Reply templates for the questions and objections my prospects are likely to raise, based on my product, site and codebase if you can see them.
- Campaign ideas and segments worth testing, with the reason for each.

Safety rules:
- Show every change as a dry run (--dry-run) first and wait for my yes. Never send emails, launch campaigns or delete anything without my yes.
- Tell me before anything that spends credits, and how many.

Be opinionated. If the docs give a sensible default, just use it. Don't make me choose between five options.
Developer docs ↗npm: @firstsales.io/cli ↗GitHub: firstsales-skills ↗