PathruleRiferimento dei comandi
Tutti i comandi di Pathrule CLI, cosa fanno e le opzioni che contano, dall'accesso e dalla configurazione del workspace fino a conoscenza, diagnostica e uso locale senza account.
In questa pagina
- Opzioni globali
- Opzioni che un comando non conosce
- Output JSON
- Codici di uscita
- Inizia
- Account e contesto
- Configurazione del workspace
- Conoscenza
- Le tue preferenze di lavoro e il modello locale
- Local Console e integrazioni con gli agenti
- Rimuovere l'integrazione dal progetto
- Diagnostica e manutenzione
- Team e fatturazione
- Aiuto e versione
- Lavorare senza account
- Cosa leggere dopo
Tutti i comandi di Pathrule CLI, raggruppati come li raggruppa pathrule help. Per ogni voce trovi cosa fa il comando e quali opzioni contano. Per una prima configurazione, parti da Installazione.
pathrule <command> [subcommand] [arguments] [options]
pathrule help
Opzioni globali
| Opzione | Cosa fa |
|---|---|
--json | Stampa un unico oggetto JSON leggibile dalle macchine al posto dell'output per le persone. Disattiva anche i colori, le richieste interattive e le finestre del browser. |
--yes | Accetta la conferma che setup e cache prune chiedono prima di modificare qualcosa. |
--no-open | Non apre mai un browser. Un comando che ne aprirebbe uno stampa invece l'URL. |
--no-color | Stampa un output semplice, senza colori. Impostare la variabile d'ambiente NO_COLOR a 1 ha lo stesso effetto. |
--local | Esegue init, setup, sync, search e i comandi memory, rule e skill su un archivio locale senza account. Vedi Lavorare senza account. |
--help, -h | Stampa l'elenco dei comandi. |
--version, -v | Stampa la versione della CLI. |
Quando la variabile d'ambiente CI vale true, la CLI salta anche le richieste interattive e le finestre del browser, così un comando non resta mai in attesa di input su un runner.
Opzioni che un comando non conosce
La CLI non rifiuta un'opzione che non riconosce. La maggior parte dei comandi la legge come un semplice argomento, e di conseguenza il comando fallisce o agisce sul target sbagliato. pathrule workspace attach --path ~/repos/app cerca un workspace chiamato --path, e pathrule install --client cursor si interrompe perché --client non è il nome di un client. setup, invite, team e memory add, rule add e skill add controllano le proprie opzioni e si fermano con un errore se ne trovano una che non conoscono. Usa le opzioni indicate in questa pagina o in pathrule help.
Output JSON
Con --json, ogni risposta è un unico oggetto JSON con ok, command e cwd, più data se il comando è riuscito, oppure error con un code e un message se non è riuscito. Alcune risposte aggiungono next_steps con i comandi da eseguire dopo. --json è disponibile sui comandi che lo indicano in --help. snapshot e eject non lo supportano, quindi eseguili senza. Accedi con un semplice pathrule login, perché il flusso di accesso deve mostrarti un codice.
Codici di uscita
0 significa che il comando ha fatto ciò che hai chiesto. La maggior parte degli errori di utilizzo, come un argomento mancante o un nome di client sconosciuto, esce con 64. Qualsiasi altro errore esce con 1, e pathrule doctor esce con 1 quando un controllo non va a buon fine. Con una versione di Node.js precedente alla 20.11.1, ogni comando si ferma con 78 prima di fare qualsiasi cosa.
Inizia
| Comando | Cosa fa |
|---|---|
pathrule setup | Collega la cartella corrente in un'unica procedura guidata. Se serve ti fa accedere, ti propone i workspace della tua organizzazione che corrispondono a questa cartella (per esempio quelli con lo stesso remote git), collega quello che scegli oppure ne crea uno con il nome della cartella, ti chiede quali client IA connettere, li installa, scrive i file che leggono e ti propone di avviare una prima scansione del progetto in uno di essi. Su un Mac con Apple Silicon, infine, propone il modello on-device opzionale. |
pathrule init [name] | Crea un workspace nell'organizzazione corrente, con il nome della cartella se non ne indichi uno, e vi collega la cartella corrente. |
Senza un terminale in cui fare domande, pathrule setup si limita a stampare un piano: l'organizzazione, i workspace corrispondenti e il comando che collegherebbe quello più adatto. Le opzioni seguenti lo fanno agire, e per agire serve --yes:
--workspace <name-or-id>collega un workspace esistente.--workspace-idè la stessa opzione.--create-workspacecrea un workspace con il nome della cartella. Aggiungi--workspace-name <name>per scegliere tu il nome.--select-workspace <name-or-id>rende corrente un workspace senza collegare questa cartella.--org <slug-or-id>cambia prima l'organizzazione.--target <client>installa la voce MCP perclaude,cursor,codex,windsurf,copilotoall.
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerun analizza di nuovo la documentazione e la cronologia dei commit del repository e prepara nuove memorie e regole candidate per la prima scansione del progetto del workspace corrente.
Account e contesto
| Comando | Cosa fa |
|---|---|
pathrule login | Esegue l'accesso con un codice monouso. La CLI stampa il codice e apre nel browser la pagina di approvazione con il codice già inserito, oppure, se non c'è un browser, stampa l'URL da aprire su qualsiasi dispositivo. --no-open non apre mai un browser. --browser-callback esegue l'accesso con GitHub in un browser su questa macchina e ritorna tramite un callback locale, e ripiega sul codice quando non è possibile. --device-code è accettato ed esegue il flusso predefinito con il codice. |
pathrule logout | Disconnette Pathrule CLI su questa macchina. --all disconnette anche le altre superfici di Pathrule su questa macchina, come l'estensione per VS Code. |
pathrule whoami | Mostra l'account con cui hai effettuato l'accesso e quando scade la sessione. |
pathrule org list | Elenca le tue organizzazioni con il tuo ruolo e segna quella corrente con *. Un semplice pathrule org fa lo stesso. |
pathrule org current | Mostra l'organizzazione corrente e il tuo ruolo al suo interno. |
pathrule org use <slug-or-id> | Cambia l'organizzazione corrente. |
pathrule workspace list | Elenca i workspace dell'organizzazione corrente e segna quello corrente con *. Un semplice pathrule workspace fa lo stesso. |
pathrule workspace current | Mostra il workspace corrente. |
pathrule workspace use <name-or-id> | Rende corrente un workspace senza collegare una cartella. |
pathrule workspace create <name> | Crea un workspace e vi collega la cartella corrente. |
pathrule workspace attach [name-or-id] | Collega la cartella corrente a un workspace esistente, individuato dal nome esatto o dall'id. Senza argomenti collega il workspace corrente. Non esiste un'opzione per il percorso: eseguilo dentro la cartella. |
pathrule workspace detach [name-or-id] | Rimuove il collegamento della cartella al workspace su questa macchina. Il workspace e il suo contenuto restano in Pathrule. |
pathrule workspace inspect | Mostra il workspace corrente nel dettaglio: organizzazione e piano, dove è collegato, il remote git, quante memorie, regole e skill contiene, l'utilizzo del piano, quali client IA sono configurati e l'attività recente. |
Collegare, creare, init e workspace use rendono anche corrente quel workspace. Comandi come memory, rule, skill, search e sync lavorano sul workspace corrente.
Configurazione del workspace
| Comando | Cosa fa |
|---|---|
pathrule attach [name-or-id] | Equivale a workspace attach. |
pathrule detach [name-or-id] | Equivale a workspace detach. |
pathrule install [client] | Scrive la voce del server MCP di Pathrule nella configurazione a livello utente del client IA e lascia invariati tutti gli altri server. Il client è claude (o claude-code), cursor, codex, windsurf, copilot (o github-copilot), oppure all, che è il valore predefinito. GitHub Copilot riceve due voci, una per la Copilot CLI e una per VS Code. |
pathrule uninstall [client] | Rimuove la voce MCP di Pathrule dalla configurazione di quel client, o di tutti e cinque. |
pathrule sync | Scrive nel repository i file che i tuoi client IA leggono: i file di istruzioni, la configurazione degli hook e l'indice locale degli hook. Eseguilo nella cartella a cui è collegato il workspace. --skills sincronizza solo le skill del workspace nelle cartelle delle skill dei tuoi client. --local sincronizza un workspace senza account. |
pathrule mcp run | Avvia il server MCP locale di Pathrule su standard input e standard output. È il comando lanciato dalla voce MCP scritta da pathrule install, quindi lo esegue il tuo client IA e non devi farlo tu. |
pathrule sync scrive i file per i client IA scelti per questo workspace in pathrule setup. Se non ne è stato scelto nessuno, li scrive per i client i cui file di Pathrule sono già presenti nel repository, e per Claude Code se non ce ne sono. Il file CLAUDE.md e la voce degli hook di Claude Code vengono aggiornati a ogni sincronizzazione. Installazione elenca ogni file. Per togliere Pathrule da un repository, vedi Rimuovere Pathrule da un progetto.
Conoscenza
| Comando | Cosa fa |
|---|---|
pathrule search <query> | Cerca tra memorie, regole e skill del workspace corrente. --type memory,rule restringe i tipi, --path /apps/api restringe la ricerca a un percorso e --limit <n> limita il numero di risultati. |
pathrule memory list | Elenca le memorie. --path o un percorso iniziale restringono l'elenco, quindi pathrule memory list /apps/api e pathrule /apps/api memory list sono equivalenti. --limit <n> lo limita. |
pathrule memory read <id-or-title> | Stampa una memoria. Passa --print per stampare per intero nel terminale i contenuti lunghi. |
pathrule memory add | Scrive una memoria con --path </node/path> --title <title>. Il corpo arriva da --body, dallo standard input oppure, se non indichi nessuno dei due, dal tuo editor (VISUAL o EDITOR). --allow-duplicate salta il controllo dei duplicati. |
pathrule rule list, read, add | Lo stesso per le regole. rule add accetta --name al posto di --title, più --priority (high, medium o low, predefinito medium) e --scope (project, folder o file_type, predefinito project). |
pathrule skill list, read, add | Lo stesso per le skill. skill add accetta --name e un --description facoltativo. |
pathrule refresh list | Elenca le attività di aggiornamento aperte, cioè le richieste di aggiornare conoscenza diventata obsoleta. --include-in-progress aggiunge quelle già prese in carico e --limit <n> limita l'elenco. |
pathrule refresh claim [id] | Prende in carico un'attività di aggiornamento, la prossima aperta se non indichi un id, e ne stampa la descrizione. |
pathrule refresh resolve <id> --status applied | Chiude un'attività di aggiornamento come applied o rejected. --note "<text>" registra il motivo. |
pathrule snapshot | Raccoglie un inventario della cartella corrente, con l'albero dei file, i manifest e brevi estratti della documentazione, il branch git e la cronologia recente, e lo carica nel workspace. Non legge il contenuto di nessun altro file. --dry-run lo stampa senza caricarlo e --notes "<text>" allega una nota. |
pathrule snapshot list [n] | Elenca gli snapshot più recenti del workspace. |
Le tue preferenze di lavoro e il modello locale
| Comando | Cosa fa |
|---|---|
pathrule me list | Elenca ciò che User Intelligence sa del tuo modo di lavorare, sia ciò che è in uso sia ciò che non lo è ancora. Un semplice pathrule me fa lo stesso. |
pathrule me teach "<sentence>" | Insegna una preferenza con parole tue. Richiede il modello on-device opzionale. |
pathrule me explain <id> | Mostra una preferenza con le evidenze che la supportano. L'id è quello breve stampato da me list. |
pathrule me scope <id> | Limita una preferenza al workspace in cui esegui il comando. --everywhere la fa valere in tutti i workspace. |
pathrule me forget <id> | Smette di usare una preferenza e la conserva come rifiutata, così le stesse evidenze non la riportano in vita. --delete la rimuove del tutto. |
pathrule me context "<task>" | Stampa ciò che un agente riceverebbe per quell'attività, e quali preferenze sono state escluse e perché. |
pathrule intelligence status | Mostra se il modello on-device è installato, la sua versione e se è disponibile un aggiornamento. Un semplice pathrule intelligence fa lo stesso. |
pathrule intelligence install | Configura il runtime locale di cui il modello ha bisogno, poi scarica il modello e ne verifica il checksum prima che diventi attivo. Richiede un Mac con Apple Silicon. |
pathrule intelligence update | Installa un modello più recente quando è disponibile. Se l'aggiornamento non riesce, resta il modello che avevi. |
pathrule intelligence remove | Rimuove il modello. Tutto ciò che non ne ha bisogno continua a funzionare come prima. |
Local Console e integrazioni con gli agenti
| Comando | Cosa fa |
|---|---|
pathrule ui | Apre la Local Console senza account per conoscenza, attività e Local Signals. --port, --no-open e --json controllano come si apre. |
pathrule integrations | Configurazione interattiva per Claude Code e Codex. Fuori da un terminale interattivo, elenca la configurazione. |
pathrule integrations add claude codex --local --dry-run | Mostra un'anteprima di un'integrazione nativa senza scrivere nulla. Scegli --cloud per la modalità Cloud. |
pathrule integrations list | Elenca gli agenti rilevati e le integrazioni registrate. |
pathrule integrations doctor | Controlli in sola lettura dell'integrazione installata. |
pathrule integrations repair | Riapplica le integrazioni di Pathrule registrate. |
pathrule integrations remove <agent> | Rimuove l'integrazione registrata. |
pathrule telemetry | Mostra la preferenza sulla telemetria e se questa CLI può inviare dati. |
pathrule telemetry enable | Attiva gli eventi anonimi di utilizzo per una CLI gestita con accesso effettuato. |
pathrule telemetry disable | Li disattiva. |
Vedi Local Console e Integrazioni native con gli agenti.
Rimuovere l'integrazione dal progetto
pathrule eject mostra un piano in sola lettura per rimuovere i file e le regioni gestite di cui Pathrule è proprietario nel repository corrente. pathrule eject --apply lo esegue dopo che l'hai esaminato. Eject non ha una forma --json. I plugin nativi si rimuovono con pathrule integrations remove <agent>.
Diagnostica e manutenzione
| Comando | Cosa fa |
|---|---|
pathrule status | Mostra l'account con cui hai effettuato l'accesso, l'organizzazione e il piano correnti, il workspace corrente e se questa cartella è collegata. |
pathrule doctor | Esegue controlli in sola lettura: accesso, organizzazione, workspace, se questa cartella è collegata, se ogni client IA ha la voce MCP di Pathrule e i file che Pathrule gestisce in questa cartella, con la superficie e la versione che ha scritto ciascuno. Quando qualcosa richiede attenzione, indica il comando successivo. Con --json il report copre anche la versione di Node.js e segnala una voce MCP il cui comando di avvio non è aggiornato. --bundle scrive un file per il supporto con credenziali e percorsi locali oscurati. |
pathrule repair | Riscrive le voci MCP di Pathrule non aggiornate nelle configurazioni dei tuoi client IA, lasciando invariati gli altri server, scrive di nuovo i file del repository e riporta cosa è cambiato. |
pathrule preflight <action> | Verifica se il tuo piano consente un'azione prima che tu la tenti. L'azione è create_workspace, write_memory, write_rule, write_skill, sync_agents o materialize_skills. |
pathrule cache prune | Elenca le cartelle di cache locali obsolete senza rimuoverle. --yes le rimuove. |
pathrule config get <key> | Legge una preferenza: update.policy, telemetry.enabled o telemetry.id. |
pathrule config set <key> <value> | update.policy manual interrompe il controllo giornaliero degli aggiornamenti, mentre notify e auto lo mantengono. telemetry.enabled false disattiva la telemetria anonima di utilizzo. Impostare la variabile d'ambiente NO_TELEMETRY a 1 ha lo stesso effetto per una singola esecuzione o shell. |
pathrule config reset telemetry-id | Sostituisce l'id di telemetria con uno nuovo. |
pathrule update | Controlla se esiste una CLI più recente e stampa il comando che la installa. Non installa mai nulla da solo. |
Una volta al giorno, un'esecuzione interattiva controlla anche se esiste una CLI più recente e stampa un avviso di una riga con il comando di aggiornamento. Indica solo una versione più recente della tua.
La CLI locale standalone non invia telemetria. Una CLI gestita con accesso effettuato invia eventi anonimi di utilizzo solo dopo che hai dato il consenso con pathrule telemetry enable. Gli eventi non contengono codice, percorsi, prompt, conoscenza, email né id di account e workspace. Disattivali con pathrule telemetry disable; NO_TELEMETRY=1, DO_NOT_TRACK=1 e la CI li tengono disattivati.
Team e fatturazione
| Comando | Cosa fa |
|---|---|
pathrule team | Elenca i membri e gli inviti in sospeso dell'organizzazione corrente, o di --org <slug-or-id>. pathrule team open apre Pathrule Web, dove si gestiscono i membri. |
pathrule invite <email> | Invita un collega nell'organizzazione corrente come editor. --role imposta admin, editor o viewer, mentre --org e --workspace impostano l'organizzazione e il workspace. Riporta se l'email di invito è stata inviata e come l'invito incide sui tuoi posti. |
pathrule billing | Apre la fatturazione dell'organizzazione in Pathrule Web. |
pathrule upgrade | Apre la fatturazione per scegliere un piano. |
Aiuto e versione
| Comando | Cosa fa |
|---|---|
pathrule help | Stampa l'elenco dei comandi. |
pathrule version | Stampa la versione della CLI, come --version. |
Lavorare senza account
Pathrule CLI funziona su un archivio locale, senza account e senza cloud. Esegui questi comandi dentro il progetto:
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name] crea un workspace locale per la cartella corrente, conservato su questa macchina, e riutilizza quello che copre già la cartella, se esiste. pathrule setup --local fa lo stesso e poi installa la voce MCP locale per ogni client IA, o per uno solo con --target <client>, installa gli hook e scrive i file del repository, il tutto senza accedere. --workspace-name <name> assegna il nome a un nuovo workspace. Le opzioni che richiedono un account, come --org o --workspace, si fermano con un errore.
In un workspace locale è il tuo agente IA a scrivere memorie, regole e skill tramite gli strumenti MCP di Pathrule. Dal terminale le leggi e le cerchi con --local:
pathrule memory list --local
pathrule rule read "No service key in browser code" --local
pathrule search "migrations" --local
pathrule sync --local
memory add, rule add e skill add richiedono un account. Con --local lo segnalano e non modificano nulla. Vedi Core open source per sapere cosa include l'edizione locale.
Cosa leggere dopo
- Installazione per la prima configurazione, cosa scrive Pathrule in un repository e come rimuoverlo.
- Pathrule CLI per sapere di cosa si occupa la CLI e quando usarla.
- User Intelligence per sapere cosa gestisce
pathrule me.