Documentation · Référence

Référence de la CLI.

@canner-ca/clidéploie sur Canner depuis n’importe quel terminal — macOS, Linux, Windows ou le terminal intégré d’un outil d’IA. Aucun git requis. Elle enrobe la même API REST que le tableau de bord; chaque commande ci-dessous correspond à un point de terminaison. Survol marketing sur la page CLI.

Installer et se connecter

npm install -g @canner-ca/cli

canner login            # paste an API token from Dashboard → Account
canner init             # creates the project + writes canner.json
canner deploy --follow  # uploads, builds, streams the log

Commandes

Configuration

canner loginDemande un jeton API et l'enregistre dans ~/.canner/credentials (mode 0600).
canner whoamiAffiche le courriel et le forfait du compte connecté.

Projets

canner projectsListe vos projets.
canner initCrée un nouveau projet Canner et écrit canner.json dans le répertoire courant.
canner statusAffiche l'état d'un projet — URL, statut, source, dernière requête.
canner openOuvre l'URL du locataire (ou, avec --dashboard, la page du tableau de bord) dans votre navigateur.

Déploiements

canner deployArchive le répertoire et le téléverse. --follow diffuse le journal de compilation et termine avec le code de retour de la compilation, ce qui convient à la dernière étape d'un pipeline CI.
canner redeployRelance une compilation depuis le HEAD du dépôt GitHub sans téléverser. Projets reliés à GitHub seulement.
canner deploymentsListe les déploiements récents, ou avec un id, affiche le journal de compilation d'un déploiement (ajoutez --follow pour diffuser si encore en cours).
canner cancelInterrompt la compilation en cours (ou une compilation précise par son id).
canner logsDiffuse les journaux d'exécution du locataire. --lines N pour l'historique, --follow pour continuer à diffuser.

Ressources

canner tokenListe, crée ou révoque les jetons API cnr_ qui authentifient la CLI et l'API.
canner envListe, définit ou supprime les variables d'environnement d'un projet (env set KEY=VALEUR, --sensitive pour masquer).
canner domainsListe, ajoute, vérifie ou supprime les domaines personnalisés d'un projet.

Sortie JSON

Ajoutez --jsonà n’importe quelle commande pour une sortie lisible par machine — tableaux et progression supprimés, une seule valeur JSON imprimée sur stdout, qui se branche dans jq ou un agent. Les erreurs vont sur stderr sous forme {"error":"…"} avec un code de sortie non nul. Avec --json, deploy --follow ne diffuse pas le journal (cela corromprait le JSON) — interrogez plutôt canner deployments <id> --json.

Ce qui est téléversé

canner deployarchive le répertoire courant et l’envoie au même point de terminaison que le glisser-déposer du tableau de bord. Ces éléments sont toujours exclus (le serveur les reconstruit), en plus de tout ce qui figure dans un .cannerignore :

node_modules, .git, .next, .nuxt, .turbo, .vercel, .svelte-kit, .DS_Store, Thumbs.db

Plafonds de taille

Starter 100 Mo · Live 500 Mo · Dedicated 1 Go. Détails des forfaits et limites.

Fichiers et environnement

~/.canner/credentialsJeton API enregistré (mode 0600).
canner.jsonSlug du projet — à versionner avec votre source.
.cannerignoreExclusions supplémentaires optionnelles (façon gitignore, sans négation).
CANNER_TOKENUtilise ce jeton au lieu du jeton enregistré (utile en CI).
CANNER_API_BASERemplace le point de terminaison de l'API (défaut https://api.canner.ca).

Voir aussi