Référence des commandes CLI WebCull
La CLI WebCull est un outil en ligne de commande pour trouver, créer et mettre à jour des favoris depuis un terminal ou un flux d'automatisation. Les commandes renvoient du JSON par défaut et sont conçues pour travailler avec de grands comptes de favoris grâce aux limites, à la pagination, à la sélection de champs et aux budgets de sortie.
webcull <command> [options]
webcull@webcull/cli~/.config/webcull/config.json, ou le chemin défini par WEBCULL_CONFIG.https://api.webcull.com. Remplacez avec WEBCULL_API_URL.Autorisez la CLI avant d'exécuter des commandes de compte
webcull login
webcull auth login
webcull whoami
webcull limits
webcull login lance un flux d'autorisation de courte durée dans le navigateur. Le terminal affiche un code d'association, le navigateur affiche le même code, et l'approbation crée un jeton CLI pour les commandes de lecture et d'écriture de favoris.
N'approuvez qu'une connexion que vous avez lancée. Comparez le code du terminal avec celui du navigateur avant d'approuver.
loginauth loginlogin.whoamilimitsCommencer large, puis récupérer des enregistrements de favoris précis
webcull bookmarks count [--path <path>]
webcull bookmarks tree [--path <path>] [--max-depth <n>] [--per-parent-limit <n>]
webcull bookmarks search --query <query> [--sort <sort>]
webcull bookmarks get --ids <ids>
bookmarks count/.bookmarks tree--limit 50, --max-depth 2 et --max-chars 12000.bookmarks search25 et le tri par défaut est modified_desc.bookmarks get--ids.Préférez count ou un tree peu profond avant de récupérer de plus grands ensembles de résultats. Utilisez get après avoir identifié les ID de favoris nécessaires.
Limiter la taille de charge utile et choisir les champs de sortie
webcull bookmarks tree --path / --max-depth 1 --limit 25 --max-chars 8000 --fields id,type,title,modified
webcull bookmarks get --ids 123,456 --fields id,title,url,notes --max-metadata-chars 1500 --format json
webcull bookmarks search --query 'github api' --limit 20 --format jsonl
--limit <n>--page <n>1.--max-chars <n>--max-metadata-chars <n>--fields <list>id,title,url,parent_id,modified.--format json|jsonljsonl affiche un élément par ligne lorsque la réponse contient une liste d'éléments.Utiliser les termes de requête, filtres de champ et analyses bornées
webcull bookmarks search --query 'github api'
webcull bookmarks search --query 'title:"github" AND notes:api'
webcull bookmarks search --query '(title:"github" OR url:"github.com") AND notes:api'
webcull bookmarks search --query 'github api' --limit 20 --max-scan-rows 500
Les comptes en texte clair utilisent la recherche côté serveur. Les comptes chiffrés utilisent automatiquement la recherche locale déchiffrée lorsque le texte des favoris doit être recherché.
E2EE search syntax
La recherche locale déchiffrée prend en charge les termes simples, les filtres de champ et AND. Les requêtes locales complexes avec OR et parenthèses sont rejetées pour la recherche locale de compte chiffré.
--max-scan-rows <n>5000.--page-size <n>200.--sort <sort>modified_desc.Créer et mettre à jour des favoris
webcull bookmarks create --url <url> [--title <title>] [--notes <text>] [--tags <tags>] [--parent-id <id>] [--parent-path <path>] [--dry-run]
webcull bookmarks create --type folder --title <title> [--parent-id <id>] [--dry-run]
webcull bookmarks update <id> [--url <url>] [--title <title>] [--notes <text>] [--tags <tags>] [--parent-id <id>] [--parent-path <path>] [--dry-run]
--url <url>--type folder--title et n'accepte pas --url.--title <title>--notes <text>--tags <tags>--parent-id <id>--parent-path <path>--parent-id.--dry-runLes commandes d'écriture préservent les champs qui ne sont pas inclus dans la commande. Elles ne prennent pas en charge les écritures groupées, écritures récursives, création automatique de dossiers, conversion favori-vers-dossier, conversion dossier-vers-favori, téléversement d'icône ou flux d'activation, désactivation ou changement de clé E2EE.
Les phrases secrètes E2EE restent dans des invites de terminal masquées
Pour les comptes E2EE, la CLI demande la phrase secrète E2EE uniquement via une saisie interactive masquée dans le terminal. Elle n'accepte jamais les phrases secrètes E2EE dans les arguments, variables d'environnement, fichiers de configuration, tubes stdin, journaux ou exemples.
Les champs chiffrés des favoris sont chiffrés localement avant les écritures et déchiffrés localement pour les lectures prises en charge. Le serveur reçoit des valeurs chiffrées et ne reçoit jamais les phrases secrètes, les clés dérivées, les hachages de phrases secrètes ni les champs de favoris déchiffrés pour la validation E2EE.
Les écritures CLI sont bloquées pendant la conversion E2EE. Terminez la conversion E2EE dans l'app avant de mettre à jour des favoris qui doivent encore être convertis.
Les jetons CLI sont séparés des sessions de navigateur
La CLI stocke son jeton dans ~/.config/webcull/config.json par défaut avec le mode de fichier 0600. Définissez WEBCULL_CONFIG pour utiliser un chemin différent.
Le jeton est séparé des sessions de navigateur et d'extension. Les jetons CLI de favoris actuels incluent bookmarks:read et bookmarks:write.
Utiliser les limites comme guide de cadence
WebCull limite les requêtes CLI pour protéger les comptes et garder le service réactif. Les commandes de lecture et d'écriture ont des limites différentes.
webcull limits avec parcimonie.En cas de réponse limitée, attendez au moins 60 secondes avant de réessayer. Resserrez la demande suivante si possible. Les écritures en simulation utilisent la limite d'écriture car elles exercent le chemin d'écriture et les vérifications de propriété.