diff --git a/cspell.json b/cspell.json index aa8dccaa..ae34c0c6 100644 --- a/cspell.json +++ b/cspell.json @@ -15,6 +15,7 @@ "Antiloop", "Cognee", "Deepgram", + "Vibecode", "Idial", "Issabel", "Sangoma", diff --git a/docs/release-notes-review.json b/docs/release-notes-review.json index e4425776..fb23b80b 100644 --- a/docs/release-notes-review.json +++ b/docs/release-notes-review.json @@ -36,10 +36,10 @@ "conclusion": "Reviewed WhatsApp v0.30.0 to v0.38.0 from the changelog and the source diff. wa now asks WhatsApp at most 20 times a minute per profile, 10 at once (was 60 and 20), and `messages sync ` asks the phone for a page every 5 to 10 seconds; `--pause` of `messages download --all`, `attachments download` and `store gaps repair` defaults to 5s. `session start` waits for the phone's own signal that its history sync is done (five minutes of quiet at most), `session start phone --json --answer-stdin` lets a window such as WireCat Desktop link by pairing code, the QR event carries `expires_at`, and `--json` reports the pairing code and the history wait as events. `account remove --keep-data|--delete-data` unlinks a profile and forgets it. `contacts add` and `contacts rename` save a WhatsApp contact name (remove and import stay refused); `contacts unlink` needs `--from`, `contacts context` reads only the asked account's scope. Queries gain name patterns in `from:` and `chat:`, `*part*` inside words, `participants_count` and `muted:`; `store import` loads a synthetic test store; `serve` exits when its build is out of date; `--offline` on a networked command is refused with `offline.refused`. From cli-core the reference also gains `models set`, `models add` (`--accept-terms` no longer needed), embeddinggemma as the default model, `search all --only meetings` without `--max-meetings`, `contacts link --reason`, bot `--button` and `--no-buttons`, `messages sync --with-muted` with `history_muted`, `keep_store_runs_for_days`, `owner_languages` and the `crm.*` settings. RU/ES changelog (0.31.0 to 0.38.0), commands (English body, as before), archive, attachments, configuration-reference, limits, people, query-language, sessions and usage reviewed; the RU query-language `kind` row's wrong wording was corrected. No correction changed. Upstream errata left for whatsapp-cli: sessions and archive still say `session start` stops after 45 seconds of quiet, and the changelog does not say that `messages sync --all` now leaves muted chats out. The roadmap is unchanged and none of its planned items shipped." }, "gcal": { - "version": "v0.34.0", + "version": "v0.35.0", "roadmapSha256": "5b408de5e9a0f7b12d4f904cd71a20a1fdc91a84a01385985e8fe74cbc9c5a97", - "reviewedAt": "2026-11-17", - "conclusion": "Reviewed gcal 0.34.0 from the changelog and the docs diff since v0.33.0. 0.34.0 builds on cli-core 0.691.0 (store schema 69): `meetings people` answers in the standard envelope with its report in `item` and its next page step in `next`, and `meetings list` names its next page with a `page.next` step. docs/index.md, the overview, was rewritten: the reader's gain first, then the start in a few minutes, the agent and the comparison. RU/ES overview (the RU opening approved by the owner, NEED-2670 A) and changelog translated. The roadmap did not change." + "reviewedAt": "2026-11-18", + "conclusion": "Reviewed gcal 0.35.0 from its changelog and the docs diff since v0.34.0. May break callers: the MCP Registry entry no longer starts `mcp serve --profiles all`; `--profiles` is a required argument, so a client set up from the registry asks which profiles to serve. A client set up from the old entry keeps `--profiles all` until it is set up again. The overview (#189) is rewritten as a sales page: what you get, the ideas a newcomer would not guess (including that over MCP a delete does not ask), an example, why gcal against its comparison, a start and plain limits. RU/ES index retranslated and changelog updated and accepted. The roadmap did not change." }, "mail": { "version": "v0.32.0", @@ -48,10 +48,10 @@ "conclusion": "Reviewed mail 0.29.0 to 0.32.0 from the changelog and the command diff since v0.28.0. 0.29.0: `rules apply` runs up to 15 minutes by default in a terminal and 45 seconds over MCP, reads headers newest first and saves batch by batch; a run that reaches its limit answers `state: partial` with a cursor, and `rules apply --cursor` goes on from there; `rules apply` takes `--yes` over MCP; `score:` and `--kind` judge a sender from the store; the time-limit error names the time limit. 0.30.0 builds on cli-core 0.659.0 and mends a shared config with a small slip, keeping a `.bak` copy. 0.31.0: `rules import --format gmail` takes its own `--yes` over MCP, `rules export` answers over MCP, a resumed `rules apply` that read nothing points to `MAIL_TIMEOUT` over MCP or adds `--timeout 30m` in a terminal, and `messages delete --rules` keeps mail from senders the owner wrote to. 0.32.0: a `readonly` level no longer stops `mail sync`; `deny` still does. RU/ES changelog and commands reviewed. The Email guide and the Yandex Telemost page were checked against the new behaviour: neither says `rules apply` needs a long `--timeout`, fails on a big mailbox or that `readonly` stops sync, so both stay unchanged; the pin moves to v0.32.0. The roadmap is unchanged since v0.17.0: its Next item, a live test of Gmail over OAuth, is not claimed as done. Earlier: Reviewed mail 0.25.0 to 0.28.0 from the changelog and the command diff since v0.24.0. `rules add --do meeting-notes:` keeps the matched mail whole and protected and saves it as a meeting on sync; `rules apply --yes` saves notes stored before the rule, and its dry run counts them. Telemost notes in Yandex's older layout take the text before the first heading as their summary, and the footer is not stored. `doctor reports show|create`, the `crm.:.activities` setting, the local-only model switch, declared hosts, and sync on a fresh install with an unreadable shared config. RU/ES changelog and commands reviewed. The Email guide does not describe any of these and stays correct; its pin moves to v0.28.0. The new Yandex Telemost page documents the meeting-notes rule. The roadmap is unchanged since v0.17.0: its Next item, a live test of Gmail over OAuth, is not claimed as done." }, "b24": { - "version": "v0.24.0", - "roadmapSha256": "fa72ac2974db647979b6c3ac78acb05bc61b37846d938d15c00c3259534ec617", - "reviewedAt": "2026-11-17", - "conclusion": "Reviewed b24 0.16.0 to 0.24.0 from the changelog and the docs diff since v0.15.0. 0.16.0 to 0.21.0: with activities on, sync reads calls, e-mails, meetings, to-dos, Bitrix24 tasks and timeline comments of the copy's deals and leads, deals show and leads show list them and search all finds a deal by their words; sync reads the stage history so a stage passed between two syncs opens its stage task; schedule list, run and exec are MCP tools; store reset is no longer offered over MCP; an unknown profile is not_found. 0.22.0 and 0.23.0: a broken shared config no longer stops sync, and a readonly level no longer stops sync. 0.24.0: Bitrix24 telephony calls in the store (meetings sync and sync copy the call history, meetings transcribe with a local model, download_recordings, calls export of other phone systems' calls, off by default), the new Calls page, b24 setup, people, organizations and users as cli-core's shared CRM commands (breaking: paging, fields, no --body), a local application signs in again after the upgrade, a non-administrator profile reads offline only its own deals and leads, download and public links are kept out of the copy and api call output, api call refuses lead reads to non-administrators. The roadmap moved activities on deals and leads out of Later, which shipped; contacts and companies from the local store stay planned. RU/ES translations of every changed page and the new Calls page reviewed and accepted; the compare page now says api call reads leads too for an administrator only." + "version": "v0.25.0", + "roadmapSha256": "f67e821673b7f32d1b66dbaba258f19008949638a2fb1b96521a553417ae6cae", + "reviewedAt": "2026-11-18", + "conclusion": "Reviewed b24 0.25.0 from its changelog and the docs diff since v0.24.0. May break callers: `meetings transcribe` answers the report beeline gives (`audio_ms` instead of `audio_seconds`, a `ref` on each failed call, a call without a recording under `failed` with `recording.missing`, no `without_recording`). Fixed: a local application sign-in saved by an earlier b24 keeps working after the upgrade. The docs rewrite (#140) and the new overview (#147) open every user page with the reader's gain: the overview is a sales page with what you get, the ideas a newcomer would not guess, an example, why b24 against its comparison and a start. RU/ES of all twelve pages updated and accepted, the changelog's pinned README links moved to v0.25.0. The roadmap now lists what works today, including the morning digest, deal activities, calls and their transcription, and adds client files and documents under Next. None of the earlier Next items shipped." }, "pbx": { "version": "v0.8.0", diff --git a/scripts/docs-corrections.json b/scripts/docs-corrections.json index d4df0a04..6db7deb5 100644 --- a/scripts/docs-corrections.json +++ b/scripts/docs-corrections.json @@ -2570,20 +2570,6 @@ ] } }, - { - "tool": "b24", - "slug": "index", - "source": "https://github.com/WireCatLabs/bitrix24-cli/blob/main/docs/index.md", - "reason": "The overview page's sidebar label is its title. b24's overview is titled with the command name; the other tools' overview pages carry the product name. Drop this once the release's own heading is Bitrix24.", - "replacements": { - "en": [ - { - "before": "title: \"b24\"", - "after": "title: \"Bitrix24\"" - } - ] - } - }, { "tool": "zm", "slug": "search", diff --git a/tools.json b/tools.json index 74fd9b4d..e335ba0c 100644 --- a/tools.json +++ b/tools.json @@ -68,7 +68,7 @@ "repo": "WireCatLabs/gcal-cli", "package": "@wirecat/gcal-cli", "lang": "en", - "docsRef": "v0.34.0", + "docsRef": "v0.35.0", "summary": { "en": "Keep your Google Calendar on your computer, search meetings offline and know who the attendees are in your other chats.", "ru": "Храните Google Календарь на своём компьютере, ищите встречи без интернета и узнавайте участников из других ваших чатов.", @@ -121,7 +121,7 @@ "repo": "WireCatLabs/bitrix24-cli", "package": "@wirecat/bitrix24-cli", "lang": "en", - "docsRef": "v0.24.0", + "docsRef": "v0.25.0", "tier": "extra", "category": "crm", "summary": { diff --git a/translations/b24/calls.es.md b/translations/b24/calls.es.md index bbc927df..dc9a11a2 100644 --- a/translations/b24/calls.es.md +++ b/translations/b24/calls.es.md @@ -2,16 +2,26 @@ title: "Llamadas" --- -Lee esta página si los teléfonos de tu empresa funcionan con la telefonía de Bitrix24. Explica cómo copiar las -llamadas del portal al almacén local de WireCat, convertir sus grabaciones en texto en este ordenador y encontrar las -llamadas de un cliente junto a sus negociaciones, mensajes y correo. Al final, `memo context` muestra las llamadas de -un cliente en su historial. +Guarda en tu ordenador las llamadas de los teléfonos de Bitrix24, con lo que se dijo como texto, en el mismo almacén +local que las negociaciones, los mensajes y el correo del cliente. El portal guarda sus llamadas en el historial de +llamadas (Telephony → Call history), y `b24` las copia de ahí. -Palabras que usa esta página: +Luego un agente te dice cuándo llamó un cliente por última vez, cómo terminó la llamada y qué se dijo en ella. Las +llamadas de otra centralita también pueden llegar al contacto del cliente en Bitrix24, para que el CRM las muestre. -- **Historial de llamadas**: la lista de llamadas que el portal guarda en Telephony → Call history. b24 la lee con el - método `voximplant.statistic.get`. -- **Perfil**: el nombre del inicio de sesión de un portal, como `work`. Es la primera palabra de un comando. +`meetings sync` copia las llamadas al almacén local de WireCat, y cada `sync` también lo hace. `meetings transcribe` +convierte las grabaciones en texto con un modelo de voz que funciona en este ordenador. `calls export` escribe en +Bitrix24 las llamadas de otras centralitas. Necesitas el permiso `telephony` del webhook. + +**En esta página:** + +1. [Antes de la primera sincronización](#before-the-first-sync) +2. [Copiar las llamadas](#copy-the-calls) +3. [El cliente y el empleado](#the-client-and-the-employee) +4. [Grabaciones](#recordings) +5. [Convertir las llamadas en texto](#turn-calls-into-text) +6. [Permisos](#permissions) +7. [Escribir en Bitrix24 las llamadas de otras centralitas](#write-other-phone-systems-calls-into-bitrix24) ## Antes de la primera sincronización @@ -31,7 +41,7 @@ igualmente. Para dejar las llamadas fuera de `sync`: `b24 work config set sync_c solo las llamadas: ```sh -b24 work meetings sync # calls since the last sync; the first reads 30 days +b24 work meetings sync # calls since the last sync, the first reads 30 days b24 work meetings sync --since-time 2026-11-01T00:00:00Z # calls from a date on b24 work meetings list # newest first, from the store, offline too b24 work meetings show 12 # one call: who, when, how it ended @@ -126,8 +136,14 @@ Las llamadas de otra centralita, como pbx, pueden llegar al contacto del cliente muestre junto a las llamadas del propio portal. Está desactivado hasta que lo actives, y escribe cada llamada una vez. Bitrix24 solo deja escribir una llamada a una aplicación, no a un webhook. Primero inicia la sesión del perfil como -aplicación local: -`b24 work session start --portal --client-id `. Luego actívalo y permite sus dos métodos: +aplicación local ([con una aplicación local](./usage.md#with-a-local-application)), con el host de tu portal y tu +Application ID en lugar de estos ejemplos: + +```sh +b24 work session start --portal example.bitrix24.ru --client-id local.0123abcd.45678901 +``` + +Luego actívalo y permite sus dos métodos: ```sh b24 work config set export_calls true diff --git a/translations/b24/calls.ru.md b/translations/b24/calls.ru.md index 47466d15..3ef80e23 100644 --- a/translations/b24/calls.ru.md +++ b/translations/b24/calls.ru.md @@ -2,16 +2,26 @@ title: "Звонки" --- -Прочитайте эту страницу, если телефоны вашей компании работают через телефонию Битрикс24. Здесь описано, как -скопировать звонки портала в локальное хранилище WireCat, превратить их записи в текст на этом компьютере и найти -звонки клиента рядом с его сделками, сообщениями и почтой. В итоге `memo context` покажет звонки клиента в его -истории. +Храните звонки с телефонов Битрикс24 на своем компьютере, вместе с текстом разговора, в том же локальном хранилище, +что и сделки, сообщения и почту клиента. Портал хранит звонки в истории звонков («Телефония → Детализация звонков»), +и `b24` копирует их оттуда. -Слова, которые использует эта страница: +Агент потом скажет, когда клиент звонил в последний раз, чем закончился звонок и о чем в нем говорили. Звонки из +другой телефонной системы тоже могут попасть в контакт клиента в Битрикс24, и CRM покажет их рядом. -- **История звонков**: список звонков, который портал хранит в разделе «Телефония → Детализация звонков». b24 читает его - методом `voximplant.statistic.get`. -- **Профиль**: имя входа на один портал, например `work`. Это первое слово команды. +`meetings sync` копирует звонки в локальное хранилище WireCat, и каждый `sync` делает это тоже. `meetings transcribe` +превращает записи в текст моделью речи, которая работает на этом компьютере. `calls export` записывает в Битрикс24 +звонки других телефонных систем. Вебхуку нужно право `telephony`. + +**На этой странице:** + +1. [Перед первой синхронизацией](#before-the-first-sync) +2. [Скопировать звонки](#copy-the-calls) +3. [Клиент и сотрудник](#the-client-and-the-employee) +4. [Записи разговоров](#recordings) +5. [Превратить звонки в текст](#turn-calls-into-text) +6. [Разрешения](#permissions) +7. [Записать звонки других телефонных систем в Битрикс24](#write-other-phone-systems-calls-into-bitrix24) ## Перед первой синхронизацией @@ -31,7 +41,7 @@ title: "Звонки" звонки: ```sh -b24 work meetings sync # calls since the last sync; the first reads 30 days +b24 work meetings sync # calls since the last sync, the first reads 30 days b24 work meetings sync --since-time 2026-11-01T00:00:00Z # calls from a date on b24 work meetings list # newest first, from the store, offline too b24 work meetings show 12 # one call: who, when, how it ended @@ -125,8 +135,14 @@ b24 work config set permissions.meetings.sync deny записывается один раз. Битрикс24 разрешает записывать звонок только приложению, а не вебхуку. Сначала войдите в профиль как локальное -приложение: -`b24 work session start --portal --client-id `. Затем включите запись и разрешите два ее метода: +приложение ([с локальным приложением](./usage.md#with-a-local-application)), подставив вместо примеров адрес своего +портала и код приложения: + +```sh +b24 work session start --portal example.bitrix24.ru --client-id local.0123abcd.45678901 +``` + +Затем включите запись и разрешите два ее метода: ```sh b24 work config set export_calls true diff --git a/translations/b24/changelog.es.md b/translations/b24/changelog.es.md index dd40886d..4e86eeab 100644 --- a/translations/b24/changelog.es.md +++ b/translations/b24/changelog.es.md @@ -4,6 +4,21 @@ title: "Historial de cambios" Cambios destacados de `@wirecat/bitrix24-cli`. Una sección por versión, de la más reciente a la más antigua. +## 0.25.0 — 17.11.2026 + +### Cambios — pueden romper scripts + +- **`meetings transcribe` devuelve el mismo informe que beeline.** La duración del audio es `audio_ms`, en + milisegundos (antes `audio_seconds`). Cada llamada fallida tiene su `ref`. Una llamada sin grabación en el portal + aparece en `failed` con el motivo `recording.missing`, y `without_recording` ya no existe. Antes, b24 y beeline + devolvían el mismo informe con dos formas, así que un script escrito para uno no podía leer el otro. + +### Corregido + +- **Un inicio de sesión con una aplicación local guardado por una versión anterior de b24 sigue funcionando tras + actualizar.** Las versiones anteriores guardaban el portal con otro nombre en el inicio de sesión, y el nuevo + almacén de inicios de sesión respondía "the saved sign-in cannot be read; sign in again". + ## 0.24.0 — 17.11.2026 ### Añadido @@ -352,13 +367,13 @@ Cambios destacados de `@wirecat/bitrix24-cli`. Una sección por versión, de la ### Corregido -- **El inicio rápido copia negociaciones.** El [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.24.0/README.md) +- **El inicio rápido copia negociaciones.** El [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.25.0/README.md) ahora elige de quién copiar negociaciones y prospectos antes del primer `sync`, que hasta entonces no copia nada. Ya no dice que un administrador copia todo el CRM, dice que por MCP un borrado con `ask` se ejecuta, y nombra `wcat-b24` para cuando se encuentra primero el comando `b24` de otro paquete. [Solución de problemas](./troubleshooting.md) incluye el error "no CRM user is chosen". - **Por MCP, `ask` no detiene una escritura.** El - [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.24.0/README.md), [seguridad](./security.md) y la + [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.25.0/README.md), [seguridad](./security.md) y la primera pantalla recomendaban poner `deals.move` en `ask` frente a los robots del portal, pero eso solo detiene un movimiento en una terminal. Por MCP nadie responde, así que la escritura sigue adelante. Ahora dicen que se ponga `readonly` o `deny`, o que se active la aprobación en el cliente del agente. diff --git a/translations/b24/changelog.ru.md b/translations/b24/changelog.ru.md index 584f79b8..e9e13489 100644 --- a/translations/b24/changelog.ru.md +++ b/translations/b24/changelog.ru.md @@ -4,6 +4,21 @@ title: "История изменений" Заметные изменения в `@wirecat/bitrix24-cli`. По одному разделу на версию, новые сверху. +## 0.25.0 — 17.11.2026 + +### Изменено — может сломать вызовы + +- **`meetings transcribe` отдает тот же отчет, что и beeline.** Длительность аудио теперь `audio_ms`, в миллисекундах + (было `audio_seconds`). У каждого звонка с ошибкой есть `ref`. Звонок без записи на портале попадает в `failed` с + причиной `recording.missing`, а `without_recording` больше нет. Раньше b24 и beeline отдавали один и тот же отчет в + двух видах, и скрипт, написанный для одного, не мог прочитать другой. + +### Исправлено + +- **Вход через локальное приложение, сохраненный прежней версией b24, работает и после обновления.** Прежние версии + хранили портал в сохраненном входе под другим именем, и новое хранилище входа отвечало "the saved sign-in cannot be + read; sign in again". + ## 0.24.0 — 17.11.2026 ### Добавлено @@ -333,13 +348,13 @@ title: "История изменений" ### Исправлено -- **Быстрый старт копирует сделки.** В [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.24.0/README.md) +- **Быстрый старт копирует сделки.** В [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.25.0/README.md) теперь до первого `sync` выбирается, чьи сделки и лиды копировать, а до этого он ничего не копирует. README больше не говорит, что администратор копирует всю CRM, говорит, что через MCP удаление с уровнем `ask` выполняется, и называет `wcat-b24` на случай, если первой находится команда `b24` из другого пакета. В [устранении неполадок](./troubleshooting.md) есть ошибка "no CRM user is chosen". - **Через MCP `ask` не останавливает запись.** - [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.24.0/README.md), [безопасность](./security.md) и + [README](https://github.com/WireCatLabs/bitrix24-cli/blob/v0.25.0/README.md), [безопасность](./security.md) и первый экран советовали ставить `deals.move` на `ask` против роботов портала. Но так перемещение останавливается только в терминале: через MCP отвечать некому, и запись проходит. Теперь там сказано ставить `readonly` или `deny` или включить подтверждение в клиенте агента. diff --git a/translations/b24/commands.es.md b/translations/b24/commands.es.md index fea5006c..cb9c4079 100644 --- a/translations/b24/commands.es.md +++ b/translations/b24/commands.es.md @@ -5,13 +5,23 @@ title: "Comandos b24" -Todos los comandos, opciones y códigos de salida, generados a partir del propio programa. Para obtener la misma lista en -JSON, ejecuta `b24 commands --json`. Las descripciones conservan el idioma de la ayuda. +Consulta cualquier comando de `b24`: qué hace, sus argumentos y opciones, qué responde y +cómo puede fallar. Cada entrada se genera a partir del propio programa, así que coincide con esa versión de `b24`. + +Aquí están, para ti o para tu agente, las palabras exactas de cada tarea, como los campos de consulta de `deals list` +o las opciones de `deals move`. Para obtener la misma lista en JSON, un agente ejecuta `b24 commands --json`. Las +descripciones conservan el idioma de la ayuda. **La primera palabra es el perfil**, un nombre que eliges tú: `b24 work config show`. `B24_PROFILE` hace lo mismo para toda una sesión de la terminal. Nunca se da un perfil por supuesto: un comando que usa una cuenta se detiene si no lo tiene y muestra los perfiles de este ordenador. +**En esta página:** + +1. [Opciones para todos los comandos](#options-for-every-command) +2. [Los comandos](#b24-commands), una sección por grupo, de `commands` a `runs` +3. [Códigos de salida](#exit-codes) + ## Opciones para todos los comandos | Option | What it does | @@ -1321,7 +1331,7 @@ b24 meetings transcribe [query] [options] | `--max-meetings ` | at most this many calls transcribed, newest first. Default: `20`. | | `--model ` | local speech model. Default: `gigaam-v3`. | -**Returns:** call transcription report — transcribed, audio_seconds, failed, without_recording, remaining, stopped; every field: b24 commands info meetings transcribe +**Returns:** call transcription report — transcribed, audio_ms, failed, remaining, stopped; every field: b24 commands info meetings transcribe **Example:** `b24 work meetings transcribe --max-meetings 20 --json`, `b24 work meetings transcribe "duration_ms>=60000" --json` diff --git a/translations/b24/commands.ru.md b/translations/b24/commands.ru.md index 1ae75c5d..753e76dc 100644 --- a/translations/b24/commands.ru.md +++ b/translations/b24/commands.ru.md @@ -5,14 +5,23 @@ title: "Команды b24" -Все команды, параметры и коды выхода, созданные из самой программы. Тот же список в JSON выводит -`b24 commands --json`. +Здесь описана любая команда `b24`: что она делает, ее аргументы и параметры, что она отвечает и +как может завершиться ошибкой. Каждая запись создана из самой программы, поэтому совпадает с этой версией `b24`. + +Здесь вы или ваш агент найдете точные слова для задачи, например поля запроса `deals list` или параметры +`deals move`. Тот же список в JSON агент получает командой `b24 commands --json`. **Первым словом идет профиль**, имя, которое вы выбираете сами: `b24 work config show`. `B24_PROFILE` задает профиль для всего сеанса оболочки. Профиль никогда не подставляется сам: команда, которой нужен аккаунт, без профиля останавливается и показывает профили на этом компьютере. Описания команд и параметров ниже остаются на языке встроенной справки. +**На этой странице:** + +1. [Параметры всех команд](#options-for-every-command) +2. [Команды](#b24-commands), по разделу на каждую группу, от `commands` до `runs` +3. [Коды выхода](#exit-codes) + ## Параметры всех команд | Option | What it does | @@ -1322,7 +1331,7 @@ b24 meetings transcribe [query] [options] | `--max-meetings ` | at most this many calls transcribed, newest first. Default: `20`. | | `--model ` | local speech model. Default: `gigaam-v3`. | -**Returns:** call transcription report — transcribed, audio_seconds, failed, without_recording, remaining, stopped; every field: b24 commands info meetings transcribe +**Returns:** call transcription report — transcribed, audio_ms, failed, remaining, stopped; every field: b24 commands info meetings transcribe **Example:** `b24 work meetings transcribe --max-meetings 20 --json`, `b24 work meetings transcribe "duration_ms>=60000" --json` diff --git a/translations/b24/configuration.es.md b/translations/b24/configuration.es.md index 591772cc..8e4c8996 100644 --- a/translations/b24/configuration.es.md +++ b/translations/b24/configuration.es.md @@ -2,8 +2,25 @@ title: "Ajustes" --- +Cambia cómo funciona `b24` para un portal, o para todos los portales de este ordenador, con un solo comando, y mira +de dónde salió cada valor. Cambias solo los pocos ajustes que te importan, y el resto conserva su valor por defecto o +queda sin definir. + +Decides, por ejemplo, qué puede hacer un agente o si se copian las grabaciones de las llamadas. Solo tú puedes +relajar un permiso: a un agente que lo intenta se le rechaza. + Los ajustes están en un único archivo, `config.json`, en la carpeta que muestra `b24 doctor`. Cada perfil tiene su -propia sección, y `defaults` se aplica a todos los perfiles. Esta página explica cómo verlos y cambiarlos. +propia sección, y `defaults` se aplica a todos los perfiles. `b24 work config` los muestra y los cambia. + +**En esta página:** + +1. [Ver y cambiar un ajuste](#see-and-change-a-setting) +2. [Permisos](#permissions) +3. [Llamadas](#calls) +4. [Relaciones del CRM](#crm-relationships) +5. [Registros de ejecución](#run-records) + +## Ver y cambiar un ajuste ```sh b24 work config show @@ -37,6 +54,6 @@ de empresa). [Quién es quién](./usage.md#who-is-who) explica los dos. Un comando que falla se guarda como ejecución, para `b24 runs list` y `runs show`. Un comando que llama al portal se guarda también cuando sale bien, con las peticiones que hizo, salvo que `record` sea `false` (entonces solo los fallos) -o que se ejecutara con `--no-record`. `record_input` decide si una ejecución guarda las palabras que escribiste; es -`true` salvo que lo pongas en `false`. Los secretos se ocultan en ambos casos; consulta +o que se ejecutara con `--no-record`. `record_input` decide si una ejecución guarda las palabras que escribiste. Es +`true` salvo que lo pongas en `false`. Los secretos se ocultan en ambos casos. Consulta [Seguridad](./security.md). diff --git a/translations/b24/configuration.ru.md b/translations/b24/configuration.ru.md index bbfec609..044b8a4e 100644 --- a/translations/b24/configuration.ru.md +++ b/translations/b24/configuration.ru.md @@ -2,8 +2,25 @@ title: "Настройки" --- +Меняйте поведение `b24` для одного портала или для всех порталов на этом компьютере одной командой и смотрите, +откуда взялось каждое значение. Вы меняете только те несколько настроек, которые вам важны, а остальные сохраняют +значения по умолчанию или остаются незаданными. + +Например, вы решаете, что может делать агент и копировать ли записи звонков. Ослабить право можете только вы: агенту, +который пытается это сделать, команда отказывает. + Настройки лежат в одном файле, `config.json`, в папке, которую показывает `b24 doctor`. У каждого профиля своя -часть, а `defaults` действуют для всех профилей. Здесь описано, как их посмотреть и изменить. +часть, а `defaults` действуют для всех профилей. `b24 work config` показывает и меняет их. + +**На этой странице:** + +1. [Посмотреть и изменить настройку](#see-and-change-a-setting) +2. [Права](#permissions) +3. [Звонки](#calls) +4. [Связи в CRM](#crm-relationships) +5. [Записи запусков](#run-records) + +## Посмотреть и изменить настройку ```sh b24 work config show @@ -38,5 +55,5 @@ b24 work config unset limit Команда, которая завершилась ошибкой, сохраняется как запуск для `b24 runs list` и `runs show`. Команда, которая обращается к порталу, сохраняется и при успехе, вместе с отправленными запросами, если только `record` не равен `false` (тогда сохраняются только ошибки) или она не запущена с `--no-record`. `record_input` решает, хранит ли запуск -введенные вами слова; он равен `true`, пока вы не зададите `false`. Секреты скрываются в любом случае; см. -[Безопасность](./security.md). +введенные вами слова. Он равен `true`, пока вы не зададите `false`. Секреты скрываются в любом случае. Подробнее на +странице [Безопасность](./security.md). diff --git a/translations/b24/index.es.md b/translations/b24/index.es.md index 737b9a23..97f10371 100644 --- a/translations/b24/index.es.md +++ b/translations/b24/index.es.md @@ -2,16 +2,155 @@ title: "Bitrix24" --- -`b24` es una herramienta de línea de comandos de WireCat para los datos de ventas de un portal de Bitrix24, desde la -terminal, desde scripts y desde agentes de IA. Lee y cambia negociaciones, prospectos, contactos (`people`) y empresas -(`organizations`), y lee embudos, etapas, productos y empleados (`users`). `sync` copia embudos, empresas, contactos, -negociaciones y prospectos al almacén local de WireCat, del que leen `deals`, `leads`, `pipelines` y `stages`, también -sin conexión; los contactos, las empresas, los productos y los empleados se leen del portal. +Sabes en qué punto está cada negociación y qué dijo un cliente por teléfono, sin abrir Bitrix24. `b24` da al agente +de IA que ya usas, como Claude Code o Codex, una copia de tus negociaciones y prospectos en tu ordenador, así que +responde a partir de esa copia, incluso sin conexión. También mueve y cierra negociaciones por ti, hasta donde lo +permitas. -Si los teléfonos de la empresa funcionan con la telefonía de Bitrix24, `meetings sync` copia también sus llamadas, y `meetings -transcribe` convierte sus grabaciones en texto en este ordenador. Consulta [Llamadas](./calls.md). +Tu agente puede decirte qué negociaciones están atascadas en "Quote sent", qué cambió en el CRM durante la noche, o +cómo fue el embudo Sales en los últimos 30 días y por qué se perdieron negociaciones. Responde con la negociación, su +importe y su responsable. Necesitas un plan de Bitrix24 que incluya la API REST, que es como los programas hablan con +el portal. -Inicia sesión con un webhook entrante del portal y actúa con los derechos del empleado que creó ese webhook. -`b24 work session status --check` dice quién es, para el perfil `work`. +**En esta página:** -Empieza por la [instalación](./installation.md) y sigue con el [uso](./usage.md). +1. [Qué obtienes](#what-you-get) +2. [Lo que no es obvio al principio](#things-a-newcomer-would-not-guess) +3. [Cómo se ve](#how-it-looks) +4. [Por qué b24](#why-b24) +5. [Qué puede hacer](#what-it-can-do) +6. [Cómo funciona](#how-it-works) +7. [Empieza en unos minutos](#start-in-a-few-minutes) +8. [Límites](#limits) +9. [Encuentra la guía para tu tarea](#find-a-guide-for-your-task) + +## Qué obtienes + +- **La respuesta, no la búsqueda.** Pregunta por una negociación o un cliente con tus propias palabras. El agente + encuentra la negociación con su importe y su responsable, leída de tu ordenador, sin recorrer el portal a clics. +- **El embudo de un vistazo.** Cuántas negociaciones llegaron a cada etapa, cuánto tardaron las cerradas y por qué se + perdieron las perdidas. +- **Mañanas que empiezan con lo que cambió.** Las negociaciones ganadas, perdidas y movidas de ayer llegan como un + resumen breve a la hora que elijas, como un aviso en tu escritorio o en tu Telegram a través de `tg` de WireCat. +- **Llamadas que puedes leer.** La grabación de una llamada con un cliente se convierte en texto en tu ordenador, así + que el agente puede decirte qué se prometió. +- **Cambios con solo pedirlos.** Basta con "Mueve Kitchen for Example a Contract signed". El agente encuentra la etapa + por su nombre, y puedes comprobar qué permisos necesita un cambio antes de que se haga. +- **Tu CRM junto a tus chats.** Una sola búsqueda encuentra una negociación junto a los mensajes, el correo y las + reuniones sobre ella que las otras herramientas de WireCat guardan en tu ordenador. + +## Lo que no es obvio al principio + +- **Un webhook es tu llave.** Bitrix24 te da un enlace que funciona como una contraseña, llamado webhook entrante. + `b24` actúa con los permisos del empleado que lo creó. `b24 work setup` muestra dónde hacer clic y qué permisos + marcar. +- **`work` es un nombre que eliges tú.** Identifica un portal, y es la primera palabra de cada comando. Ningún comando + elige un portal por ti. +- **La copia guarda negociaciones, no todo el CRM.** Una sincronización copia las negociaciones y los prospectos del + empleado del webhook o, con el webhook de un administrador, de los compañeros que elijas, con sus clientes, embudos y + etapas. Los contactos, las empresas y los empleados se leen del portal cada vez. +- **Por MCP, "preguntar" deja pasar el comando.** MCP es la forma en que aplicaciones como Claude Desktop llaman a una + herramienta, y nadie está ahí para responder una pregunta. Antes de conectarla, marca como "solo lectura" o + "rechazar" los cambios que un agente no debe hacer. +- **Un cambio de etapa puede poner en marcha los robots del portal**, que pueden escribir a tus clientes. Decide quién + puede mover una negociación antes de dar el perfil a un agente. + +## Cómo se ve + +```text +You: Which of my deals are in Quote sent? +Agent: (runs b24 work deals list stage:"Quote sent" owner:me) + · "Kitchen for Example", 15 000 EUR, deal 42 + · "Office for Sample", 8 200 EUR, deal 57 +You: Move Kitchen for Example to Contract signed. +Agent: (runs b24 work deals move deal:42 "Contract signed") + Done. "Kitchen for Example" (deal 42) is in Contract signed now. +``` + +## Por qué b24 + +- **Una copia de tus negociaciones en tu ordenador.** De las cinco herramientas de la + [comparativa](https://wirecat.dev/en/docs/b24/compare), entre ellas Vibecode MCP, la del propio Bitrix24, ninguna + otra documenta la lectura de negociaciones y prospectos sin internet. La siguiente sincronización trae solo los + cambios. +- **Un permiso en cada acción.** Permitir, preguntar, solo lectura o rechazar, para cada comando y cada método de + Bitrix24. Los métodos que escriben a clientes o inician procesos de negocio, y pasar una negociación a un compañero, + se rechazan hasta que los permitas. +- **Cambios que puedes comprobar antes.** `--dry-run` no envía nada y muestra qué permisos necesita el cambio. Un + cambio que perdió su respuesta nunca se reenvía solo, así que una conexión cortada no crea una segunda negociación. +- **Respetuoso con el portal.** Bitrix24 permite unas 2 peticiones por segundo para todas sus aplicaciones juntas. + `b24` mantiene ese ritmo, y la mayoría de las respuestas no necesitan ninguna petición. +- **El webhook se queda en el llavero del sistema.** Nunca aparece en la salida, los errores ni los registros. +- **Gratis y de código abierto.** Apache 2.0. + +Otra herramienta te conviene más si quieres Bitrix24 en ChatGPT o Claude en el navegador sin nada que ejecutar en tu +ordenador (Zapier MCP), o más de Bitrix24 que los datos de ventas, como tareas y chats (Vibecode MCP). + +## Qué puede hacer + +- **Negociaciones y prospectos:** listas por etapa, embudo o responsable, ver uno con las etapas por las que pasó, + crear, mover, cerrar como ganada o perdida, y rellenar los campos propios de tu portal por su etiqueta. + [Úsalo](./usage.md) +- **El embudo:** cada etapa con su número, su suma y cuántas siguieron adelante, y los últimos 30 días con el tiempo + hasta el cierre y los motivos de pérdida. [Úsalo](./usage.md) +- **Contactos y empresas:** leerlos, crearlos y actualizarlos, y exportar una lista a un archivo CSV para una hoja de + cálculo. Los empleados se pueden leer. [Úsalo](./usage.md) +- **Llamadas:** el historial de llamadas del portal, y las grabaciones convertidas en texto en tu ordenador. + [Llamadas](./calls.md) +- **Qué cambió:** negociaciones creadas, movidas, ganadas y perdidas en el periodo que elijas, y un resumen + programado. [Úsalo](./usage.md) +- **El trabajo en una negociación:** sus llamadas, correos, reuniones, tareas y comentarios del historial cuando los + activas, y una tarea en tu ordenador cada vez que una negociación entra en una etapa que nombres. [Úsalo](./usage.md) +- **Cualquier método de Bitrix24** desde una terminal, con las mismas comprobaciones de permisos. + [Comandos](./commands.md) + +## Cómo funciona + +- **Una copia en tu ordenador.** `sync` guarda tus negociaciones y prospectos en el almacén local de WireCat, el único + archivo de tu ordenador que comparten todas las herramientas de WireCat. Las listas, el embudo y la búsqueda lo + leen, también sin conexión. +- **Inicio de sesión con un webhook o una aplicación local.** Cualquiera de los dos se guarda en el llavero del + sistema, o en un archivo privado en un ordenador sin llavero. +- **Hecho para scripts y agentes.** `--json` da una respuesta JSON, y un error trae un código con el que decidir el + siguiente paso. [MCP](./mcp.md) +- **Qué se guarda y qué pasa por la red.** [Seguridad](./security.md) + +## Empieza en unos minutos + +Pega esto en el chat con tu agente: + +```text prompt +Instala b24 con npm install -g @wirecat/bitrix24-cli. Ayúdame a ejecutar b24 work setup para conectar mi portal de Bitrix24, y después sincronizar y mostrar mis negociaciones abiertas. +``` + +O en una terminal: + +```sh +npm install -g @wirecat/bitrix24-cli +b24 skill install # teaches Claude Code, Codex and Gemini CLI to use b24 +b24 work setup # make an inbound webhook in Bitrix24, tick its permissions, paste its address +b24 work sync # copy your deals, leads and their clients +b24 work deals list status:open # your open deals, read from the copy +``` + +Necesitas Node.js 22.16 o una versión 22.x posterior, o Node.js 24 o posterior. [Instalar](./installation.md) + +## Límites + +- Probado en Bitrix24 en la nube. Un portal en un servidor propio no está probado. +- La API REST viene con los planes Vibe+ de Bitrix24 y la prueba de 15 días, no con los planes Essentials + ([página de Bitrix24](https://apidocs.bitrix24.com/first-steps/access-to-rest-api.html)). +- Los contactos, las empresas, los productos y los empleados se leen del portal cada vez, así que necesitan internet. + +## Encuentra la guía para tu tarea + +| Tarea | Guía | +|---|---| +| Instalar y conectar un portal | [Instalar](./installation.md) | +| Leer y cambiar negociaciones, el resumen, agentes | [Úsalo](./usage.md) | +| Llamadas y su texto | [Llamadas](./calls.md) | +| Conectar una aplicación que usa MCP | [MCP](./mcp.md) | +| Decidir qué puede cambiar un agente | [Permisos](./permissions.md) | +| Un comando o una opción exactos | [Comandos](./commands.md) | +| Algo no funciona | [Cuando algo falla](./troubleshooting.md) | +| En qué se diferencia b24 de otras herramientas de Bitrix24 | [Comparativa](https://wirecat.dev/en/docs/b24/compare) | diff --git a/translations/b24/index.ru.md b/translations/b24/index.ru.md index 1f0610b0..c04b0d56 100644 --- a/translations/b24/index.ru.md +++ b/translations/b24/index.ru.md @@ -2,16 +2,151 @@ title: "Bitrix24" --- -`b24` — инструмент командной строки WireCat для данных продаж на портале Битрикс24: для терминала, для скриптов и для -ИИ-агентов. Он читает и меняет сделки, лиды, контакты (`people`) и компании (`organizations`), а также читает воронки, -стадии, товары и сотрудников (`users`). `sync` копирует воронки, компании, контакты, сделки и лиды в локальное -хранилище WireCat, из которого читают `deals`, `leads`, `pipelines` и `stages`, в том числе без сети; контакты, -компании, товары и сотрудники читаются с портала. +Вы узнаете, на какой стадии каждая сделка и что клиент сказал по телефону, не открывая Битрикс24. `b24` передает +ИИ-агенту, которым вы уже пользуетесь, например Claude Code или Codex, копию ваших сделок и лидов на вашем компьютере, и +агент отвечает по этой копии, даже без сети. Еще он переводит сделки на другие стадии и закрывает их за вас, в тех +пределах, которые вы разрешите. -Если телефоны компании работают через телефонию Битрикс24, `meetings sync` копирует и ее звонки, а `meetings -transcribe` превращает их записи в текст на этом компьютере. См. [Звонки](./calls.md). +Агент ответит, какие сделки застряли на стадии "Quote sent", что изменилось в CRM за ночь и как прошла воронка Sales +за последние 30 дней и почему сделки были проиграны. В ответе будут сделка, ее сумма и ответственный. Нужен тариф +Битрикс24 с REST API: через него программы работают с порталом. -Он входит через входящий вебхук портала и действует с правами сотрудника, который создал этот вебхук. -`b24 work session status --check` показывает, кто это, для профиля `work`. +**На этой странице:** -Начните с [установки](./installation.md), затем перейдите к [работе с инструментом](./usage.md). +1. [Что вы получите](#what-you-get) +2. [Что неочевидно с первого раза](#things-a-newcomer-would-not-guess) +3. [Как это выглядит](#how-it-looks) +4. [Почему b24](#why-b24) +5. [Что умеет b24](#what-it-can-do) +6. [Как это устроено](#how-it-works) +7. [Начните за несколько минут](#start-in-a-few-minutes) +8. [Ограничения](#limits) +9. [Найдите инструкцию под свою задачу](#find-a-guide-for-your-task) + +## Что вы получите + +- **Ответ вместо поиска.** Спросите о сделке или клиенте своими словами. Агент найдет сделку с суммой и + ответственным, прочитав ее на вашем компьютере, и вам не придется ходить по порталу. +- **Воронка одним взглядом.** Сколько сделок дошло до каждой стадии, сколько времени заняли закрытые и почему + сорвались проигранные. +- **Утро начинается с того, что изменилось.** Вчерашние выигранные, проигранные и перемещенные сделки приходят + короткой сводкой в выбранное вами время, уведомлением на рабочем столе или в ваш Telegram через `tg` от WireCat. +- **Звонки, которые можно прочитать.** Запись звонка клиента превращается в текст на вашем компьютере, и агент может + сказать, что было обещано. +- **Изменения по запросу.** Достаточно написать "Переведи Kitchen for Example в Contract signed". Агент находит стадию + по названию, а до изменения вы можете проверить, какие разрешения для него нужны. +- **CRM рядом с чатами.** Один поиск находит сделку рядом с сообщениями, почтой и встречами о ней, которые другие + инструменты WireCat хранят на вашем компьютере. + +## Что неочевидно с первого раза + +- **Вебхук служит ключом.** Битрикс24 дает вам ссылку, которая работает как пароль, она называется входящий вебхук. + `b24` действует с правами сотрудника, который ее создал. `b24 work setup` показывает, куда нажать и какие разрешения + отметить. +- **Имя `work` вы выбираете сами.** Оно обозначает один портал, и с него начинается каждая команда. Ни одна команда + не выбирает портал за вас. +- **В копии сделки, а не вся CRM.** Синхронизация копирует сделки и лиды сотрудника, который создал вебхук, а если + вебхук создал администратор, то сделки и лиды выбранных вами коллег, вместе с их клиентами, воронками и + стадиями. Контакты, компании и сотрудники каждый раз читаются с портала. +- **Через MCP "спросить" пропускает команду.** Через MCP приложения вроде Claude Desktop вызывают инструмент, и там + некому ответить на вопрос. Поэтому до подключения поставьте "только чтение" или "запретить" на изменения, которые + агенту вносить нельзя. +- **Смена стадии может запустить роботов портала**, а они могут написать вашим клиентам. Решите, кто может двигать + сделки, до того как агент получит профиль. + +## Как это выглядит + +```text +You: Which of my deals are in Quote sent? +Agent: (runs b24 work deals list stage:"Quote sent" owner:me) + · "Kitchen for Example", 15 000 EUR, deal 42 + · "Office for Sample", 8 200 EUR, deal 57 +You: Move Kitchen for Example to Contract signed. +Agent: (runs b24 work deals move deal:42 "Contract signed") + Done. "Kitchen for Example" (deal 42) is in Contract signed now. +``` + +## Почему b24 + +- **Копия ваших сделок на вашем компьютере.** Из пяти инструментов в + [сравнении](https://wirecat.dev/en/docs/b24/compare), среди них собственный Vibecode MCP от Битрикс24, ни один другой + не описывает чтение сделок и лидов без интернета. Следующая синхронизация берет только изменения. +- **Разрешение на каждое действие.** Разрешить, спросить, только чтение или запретить, для каждой команды и каждого + метода Битрикс24. Методы, которые пишут клиентам или запускают бизнес-процессы, и передача сделки коллеге запрещены, + пока вы их не разрешите. +- **Изменения можно сначала проверить.** `--dry-run` ничего не отправляет и показывает, какие разрешения нужны для + изменения. Изменение, ответ на которое потерялся, никогда не отправляется повторно само, поэтому оборванное + соединение не создаст вторую сделку. +- **Бережно к порталу.** Битрикс24 разрешает около 2 запросов в секунду на все свои приложения вместе. `b24` держит + этот темп, а большинству ответов запрос к порталу вообще не нужен. +- **Вебхук хранится в связке ключей системы.** Его никогда не видно в выводе, ошибках или журналах. +- **Бесплатно и с открытым кодом.** Лицензия Apache 2.0. + +Другой инструмент подойдет лучше, если вам нужен Битрикс24 в ChatGPT или Claude в браузере и на компьютере ничего не +должно работать (Zapier MCP), или нужны не только данные о продажах, а например задачи и чаты (Vibecode MCP). + +## Что умеет b24 + +- **Сделки и лиды:** списки по стадии, воронке или ответственному, одна сделка с пройденными стадиями, создать, + перевести на другую стадию, закрыть как успешную или проигранную, заполнить собственные поля портала по их + названию. [Работа с инструментом](./usage.md) +- **Воронка:** каждая стадия с количеством, суммой и тем, сколько сделок прошло дальше, и последние 30 дней со + временем до закрытия и причинами проигрыша. [Работа с инструментом](./usage.md) +- **Контакты и компании:** читать, создавать и обновлять их и выгружать список в CSV-файл для таблицы. Сотрудников + можно читать. [Работа с инструментом](./usage.md) +- **Звонки:** история звонков портала и записи, превращенные в текст на вашем компьютере. [Звонки](./calls.md) +- **Что изменилось:** сделки, созданные, перемещенные, выигранные и проигранные за выбранный вами период, и сводка + по расписанию. [Работа с инструментом](./usage.md) +- **Работа по сделке:** ее звонки, письма, встречи, задачи и комментарии в ленте, когда вы их включите, и задача на + вашем компьютере каждый раз, когда сделка входит в указанную вами стадию. [Работа с инструментом](./usage.md) +- **Любой метод Битрикс24** из терминала, с теми же проверками разрешений. [Команды](./commands.md) + +## Как это устроено + +- **Копия на вашем компьютере.** `sync` складывает ваши сделки и лиды в локальное хранилище WireCat, один файл на + вашем компьютере, общий для всех инструментов WireCat. Списки, воронка и поиск читают его, в том числе без сети. +- **Вход через вебхук или локальное приложение.** И то и другое хранится в связке ключей системы, а на компьютере без + нее в закрытом файле. +- **Для скриптов и агентов.** `--json` дает ответ в JSON, а у ошибки есть код, по которому можно выбрать следующий + шаг. [MCP](./mcp.md) +- **Что хранится и что передается по сети.** [Безопасность](./security.md) + +## Начните за несколько минут + +Вставьте это в чат с агентом: + +```text prompt +Установи b24 командой npm install -g @wirecat/bitrix24-cli. Помоги мне запустить b24 work setup, чтобы подключить мой портал Битрикс24, потом синхронизировать данные и показать мои открытые сделки. +``` + +Или в терминале: + +```sh +npm install -g @wirecat/bitrix24-cli +b24 skill install # teaches Claude Code, Codex and Gemini CLI to use b24 +b24 work setup # make an inbound webhook in Bitrix24, tick its permissions, paste its address +b24 work sync # copy your deals, leads and their clients +b24 work deals list status:open # your open deals, read from the copy +``` + +Нужен Node.js 22.16 или новее в ветке 22, либо Node.js 24 и новее. [Установка](./installation.md) + +## Ограничения + +- Проверено на облачном Битрикс24. Коробочный портал не проверялся. +- REST API есть в тарифах Битрикс24 Vibe+ и в 15-дневном пробном периоде, но не в тарифах Essentials + ([страница Битрикс24](https://apidocs.bitrix24.com/first-steps/access-to-rest-api.html)). +- Контакты, компании, товары и сотрудники каждый раз читаются с портала, поэтому для них нужен интернет. + +## Найдите инструкцию под свою задачу + +| Задача | Куда перейти | +|---|---| +| Установить и подключить портал | [Установка](./installation.md) | +| Читать и менять сделки, сводка, агенты | [Работа с инструментом](./usage.md) | +| Звонки и их текст | [Звонки](./calls.md) | +| Подключить приложение с MCP | [MCP](./mcp.md) | +| Решить, что агенту можно менять | [Разрешения](./permissions.md) | +| Точная команда или параметр | [Команды](./commands.md) | +| Что-то не работает | [Если что-то пошло не так](./troubleshooting.md) | +| Чем b24 отличается от других инструментов для Битрикс24 | [Сравнение](https://wirecat.dev/en/docs/b24/compare) | diff --git a/translations/b24/installation.es.md b/translations/b24/installation.es.md index a1c43b6b..593327cf 100644 --- a/translations/b24/installation.es.md +++ b/translations/b24/installation.es.md @@ -2,21 +2,37 @@ title: "Instalar" --- -Instala `b24` una vez en cada ordenador donde lo uses tú o un agente. Necesitas Node.js 22.16 o una versión 22.x posterior, o la 24 o posterior; Node 23 no es compatible. +Pon `b24` en marcha en tu ordenador y conéctalo a tu portal de Bitrix24 en pocos minutos. Bitrix24 solo deja entrar a +un programa a través de un webhook entrante o de una aplicación que creas en el portal, y esta página configura uno de +los dos. -```sh -npm install -g @wirecat/bitrix24-cli -b24 --version -``` +Cuando termines, un agente en este ordenador lee tus negociaciones, prospectos y clientes, y los cambia cuando se lo +pides. + +npm instala `b24` como comando, y `b24 skill install` enseña a tu agente a usarlo. `b24 work setup` te muestra dónde +crear el webhook en Bitrix24 y qué permisos de acceso (scopes) marcar, comprueba la dirección del webhook con el portal +y la guarda en el llavero del sistema. `b24 doctor` muestra qué está configurado, sin red. Necesitas Node.js 22.16 o +una versión 22.x posterior, o la 24 o posterior. Node 23 no es compatible. + +**En esta página:** + +1. [Instalar la herramienta](#install-the-tool) +2. [Iniciar sesión](#sign-in) + +## Instalar la herramienta -Comprueba la instalación y luego elige un nombre de perfil para tu cuenta, por ejemplo `work`: +Instala `b24` una vez en cada ordenador donde lo uses tú o un agente. ```sh +npm install -g @wirecat/bitrix24-cli +b24 --version +b24 skill install # the agent skill, for Claude Code, Codex, Gemini CLI and OpenClaw b24 doctor ``` -`doctor` no necesita red ni abre ningún llavero. Muestra la versión, dónde están los ajustes, qué perfiles existen y si -otros usuarios del ordenador pueden leer los ajustes. Siguiente paso: [úsalo](./usage.md). +Un agente sin terminal, como Claude Desktop, usa `b24` a través de [MCP](./mcp.md). `doctor` no necesita red ni abre +ningún llavero. Muestra la versión, dónde están los ajustes, qué perfiles existen y si otros usuarios del ordenador +pueden leer los ajustes. Luego elige un nombre de perfil para tu portal, por ejemplo `work`. ## Iniciar sesión @@ -29,6 +45,13 @@ webhook. Créala una vez en el portal (Developer resources → Common use cases **Server**, con **Your handler path** `https://wirecat.dev/webhooks/apps/b24-callback`, el campo **Initial installation path** vacío, sin texto para el elemento de menú y con los permisos de acceso `crm`, `user_basic` y `department`, `task` para las tareas, `telephony` para las llamadas, y `disk` y `documentgenerator` para los -archivos y documentos. Luego ejecuta -`b24 work session start --portal example.bitrix24.ru --client-id ` y escribe la Application key cuando -te la pida. Los pasos están en [con una aplicación local](./usage.md#with-a-local-application). +archivos y documentos. Luego ejecuta `session start` con el host de tu portal y el Application ID que muestra +Bitrix24. Aquí el host es `example.bitrix24.ru` y el ID `local.0123abcd.45678901`, así que pon los tuyos en su lugar: + +```sh +b24 work session start --portal example.bitrix24.ru --client-id local.0123abcd.45678901 +``` + +Escribe la Application key cuando te la pida. Los pasos están en [con una aplicación local](./usage.md#with-a-local-application). + +Siguiente paso: [úsalo](./usage.md). diff --git a/translations/b24/installation.ru.md b/translations/b24/installation.ru.md index 4d84885a..0369e023 100644 --- a/translations/b24/installation.ru.md +++ b/translations/b24/installation.ru.md @@ -2,22 +2,35 @@ title: "Установка" --- -Установите `b24` один раз на каждом компьютере, где им пользуетесь вы или агент. Нужен Node.js 22.16 или более -поздний 22.x, либо 24 и новее; Node 23 не поддерживается. +За несколько минут `b24` заработает на вашем компьютере и подключится к порталу Битрикс24. Битрикс24 пускает программу +только через входящий вебхук или приложение, которое вы создаете на портале, и эта страница настраивает одно из них. -```sh -npm install -g @wirecat/bitrix24-cli -b24 --version -``` +После этого агент на компьютере читает ваши сделки, лиды и клиентов и меняет их, когда вы попросите. + +npm ставит `b24` как команду, а `b24 skill install` учит агента ею пользоваться. `b24 work setup` показывает, где +создать вебхук в Битрикс24 и какие права (scope) отметить, проверяет адрес вебхука на портале и хранит его в связке +ключей системы. `b24 doctor` показывает, что настроено, без сети. Нужен Node.js 22.16 или более поздний 22.x, либо 24 +и новее. Node 23 не поддерживается. + +**На этой странице:** + +1. [Установка инструмента](#install-the-tool) +2. [Вход](#sign-in) + +## Установка инструмента -Проверьте установку, затем выберите имя профиля для своего аккаунта, например `work`: +Установите `b24` один раз на каждом компьютере, где им пользуетесь вы или агент. ```sh +npm install -g @wirecat/bitrix24-cli +b24 --version +b24 skill install # the agent skill, for Claude Code, Codex, Gemini CLI and OpenClaw b24 doctor ``` -`doctor` не нужна сеть, и он не открывает связку ключей. Он показывает версию, где лежат настройки, какие профили -есть и могут ли другие пользователи компьютера читать настройки. Дальше: [работа с инструментом](./usage.md). +Агент без терминала, например Claude Desktop, работает с `b24` через [MCP](./mcp.md). `doctor` не нужна сеть, и он +не открывает связку ключей. Он показывает версию, где лежат настройки, какие профили есть и могут ли другие +пользователи компьютера читать настройки. Затем выберите имя профиля для своего портала, например `work`. ## Вход @@ -30,5 +43,13 @@ Desktop. `b24 work session start` только спрашивает адрес. вашего обработчика** укажите `https://wirecat.dev/webhooks/apps/b24-callback`, поле **Путь для первоначальной установки** и текст пункта меню оставьте пустыми, в правах доступа отметьте `crm`, `user_basic` и `department`, а также `task` для задач, `telephony` для звонков, `disk` и `documentgenerator` для файлов и документов. -Затем выполните `b24 work session start --portal example.bitrix24.ru --client-id ` и введите ключ -приложения, когда команда его попросит. Шаги описаны в разделе [с локальным приложением](./usage.md#with-a-local-application). +Затем выполните `session start` с адресом своего портала и кодом приложения (client_id), который показывает Битрикс24. +Здесь адрес `example.bitrix24.ru`, а код `local.0123abcd.45678901`, подставьте свои: + +```sh +b24 work session start --portal example.bitrix24.ru --client-id local.0123abcd.45678901 +``` + +Введите ключ приложения, когда команда его попросит. Шаги описаны в разделе [с локальным приложением](./usage.md#with-a-local-application). + +Дальше: [работа с инструментом](./usage.md). diff --git a/translations/b24/mcp.es.md b/translations/b24/mcp.es.md index 3390cdbd..64ff13be 100644 --- a/translations/b24/mcp.es.md +++ b/translations/b24/mcp.es.md @@ -2,13 +2,23 @@ title: "MCP" --- -Usa esta página para dar a un agente de IA tu CRM por MCP (Model Context Protocol), la forma en que un agente pregunta -a un programa qué sabe hacer y luego lo llama. A un agente con terminal, como Claude Code o Codex, le van mejor los -comandos y la skill (`b24 skill install`). MCP es para un cliente que no puede ejecutar comandos: una aplicación de -chat, un agente remoto, ChatGPT o Claude en el navegador. +Da tu CRM de Bitrix24 a un agente de IA que no puede ejecutar comandos, como Claude Desktop, o ChatGPT y Claude en el +navegador. MCP (Model Context Protocol) es la forma en que un agente así pregunta a un programa qué sabe hacer y luego +lo llama, y `b24` ofrece sus comandos de esa forma. -Antes de empezar, inicia sesión en el perfil (`b24 work session start`, con un webhook o una aplicación local) y lee -[Permisos](./permissions.md), porque por MCP una escritura en `ask` sigue adelante. +Así el agente lee tus negociaciones, prospectos y clientes, y los cambia hasta donde lo permiten los permisos del perfil. + +`b24 work mcp add` añade el servidor a Claude Code o Codex, y `b24 work mcp config` imprime la entrada para cualquier +otro cliente. A un agente con terminal, como Claude Code o Codex, le van mejor los comandos y la skill +(`b24 skill install`). Necesitas un perfil con la sesión iniciada, y antes conviene mirar +[Permisos](./permissions.md): por MCP una escritura en `ask` sigue adelante. + +**En esta página:** + +1. [Añade b24 a un agente](#add-b24-to-an-agent) +2. [Lo que ve el agente](#what-the-agent-sees) +3. [Las escrituras siguen siendo tuyas](#keep-writes-yours) +4. [ChatGPT y Claude en el navegador](#chatgpt-and-claude-in-the-browser) ## Añade b24 a un agente diff --git a/translations/b24/mcp.ru.md b/translations/b24/mcp.ru.md index 694bf9c0..afc0ed91 100644 --- a/translations/b24/mcp.ru.md +++ b/translations/b24/mcp.ru.md @@ -2,13 +2,23 @@ title: "MCP" --- -Эта страница о том, как дать ИИ-агенту вашу CRM через MCP (Model Context Protocol). Так агент спрашивает программу, -что она умеет, и потом вызывает ее. Агенту с терминалом, например Claude Code или Codex, лучше подходят команды и -навык (`b24 skill install`). MCP нужен клиенту, который не может запускать команды: приложению чата, удаленному -агенту, ChatGPT или Claude в браузере. +Дайте вашу CRM в Битрикс24 ИИ-агенту, который не умеет запускать команды, например Claude Desktop, ChatGPT или +Claude в браузере. MCP (Model Context Protocol) это способ, которым такой агент спрашивает программу, что она умеет, и +потом вызывает ее. `b24` отдает свои команды именно так. -Перед началом войдите в профиль (`b24 work session start`, с вебхуком или локальным приложением) и прочитайте -[Разрешения](./permissions.md), потому что через MCP запись на уровне `ask` выполняется. +Тогда агент читает ваши сделки, лиды и клиентов и меняет их настолько, насколько разрешают права профиля. + +`b24 work mcp add` добавляет сервер в Claude Code или Codex, а `b24 work mcp config` выводит запись для любого другого +клиента. Агенту с терминалом, например Claude Code или Codex, лучше подходят команды и навык +(`b24 skill install`). Вам нужен профиль, в который выполнен вход, и сначала стоит заглянуть в +[Разрешения](./permissions.md): через MCP запись на уровне `ask` выполняется. + +**На этой странице:** + +1. [Подключите b24 к агенту](#add-b24-to-an-agent) +2. [Что видит агент](#what-the-agent-sees) +3. [Записи остаются под вашим контролем](#keep-writes-yours) +4. [ChatGPT и Claude в браузере](#chatgpt-and-claude-in-the-browser) ## Подключите b24 к агенту diff --git a/translations/b24/permissions.es.md b/translations/b24/permissions.es.md index e7f49d2a..733141e5 100644 --- a/translations/b24/permissions.es.md +++ b/translations/b24/permissions.es.md @@ -2,17 +2,26 @@ title: "Permisos" --- -Lee esta página antes de dejar que un agente de IA, un script o un compañero cambie tu CRM a través de `b24`. Muestra -cómo decidir, para cada perfil, qué solo se puede leer, qué te pregunta antes y qué puede seguir adelante. Al final -puedes impedir que los agentes muevan negociaciones o borren, y sabes qué comprobaciones se mantienen digan lo que -digan los permisos. - -Palabras que usa esta página: - -- **Perfil**: el nombre que diste al inicio de sesión de un portal, como `work`. Es la primera palabra de un comando. -- **Clave de permiso**: el nombre de un comando, como `deals.move`, o de un grupo de comandos, como `deals`. Una clave - más larga es más específica y gana. -- **Nivel**: qué pasa cuando se ejecuta el comando: `deny`, `readonly`, `ask` o `allow`. +Deja que un agente de IA trabaje en tu CRM a través de `b24` y conserva la última palabra sobre lo que cambia. El +webhook lleva los derechos de su empleado en Bitrix24, así que sin tus propios límites un agente podría hacer mucho de +lo que puede ese empleado. + +Para cada perfil, el nombre que diste al inicio de sesión de un portal, decides qué solo puede leer un agente, qué te +pregunta antes y qué sigue adelante. Puedes impedir que un agente mueva o borre negociaciones, y sabes qué +comprobaciones se mantienen digan lo que digan los ajustes. + +Cada comando tiene una clave de permiso, su nombre como `deals.move`, o un grupo como `deals`, y gana la clave más +larga. Cada clave tiene un nivel: `deny`, `readonly`, `ask` o `allow`. `b24 work config set` los fija, y `--dry-run` +muestra qué claves comprueba un comando. + +**En esta página:** + +1. [Los niveles](#the-levels) +2. [Lo que está fijado antes de que cambies nada](#what-is-set-before-you-change-anything) +3. [Un comando puede comprobar varias claves](#one-command-can-check-several-keys) +4. [Los cambios de etapa ponen en marcha los robots del portal](#stage-changes-start-the-portals-robots) +5. [Agentes y MCP](#agents-and-mcp) +6. [Comprobaciones que se mantienen digan lo que digan los permisos](#checks-that-hold-whatever-the-permissions-say) ## Los niveles diff --git a/translations/b24/permissions.ru.md b/translations/b24/permissions.ru.md index a781f57e..b2d22e6c 100644 --- a/translations/b24/permissions.ru.md +++ b/translations/b24/permissions.ru.md @@ -2,17 +2,26 @@ title: "Разрешения" --- -Прочитайте эту страницу, прежде чем давать ИИ-агенту, скрипту или коллеге менять вашу CRM через `b24`. Здесь -показано, как решить для каждого профиля, что можно только читать, что сначала спрашивает вас и что выполняется -сразу. После нее вы сможете запретить агентам двигать сделки и удалять и будете знать, какие проверки действуют -независимо от разрешений. - -Слова, которые использует эта страница: - -- **Профиль**: имя, которое вы дали входу на один портал, например `work`. Это первое слово команды. -- **Ключ прав**: имя команды, например `deals.move`, или группы команд, например `deals`. Более длинный ключ - точнее и побеждает. -- **Уровень**: что происходит при запуске команды: `deny`, `readonly`, `ask` или `allow`. +Дайте ИИ-агенту работать в вашей CRM через `b24` и оставьте за собой решение, что он меняет. Вебхук несет права +своего сотрудника в Битрикс24, поэтому без ваших собственных ограничений агент мог бы сделать многое из того, что +может этот сотрудник. + +Для каждого профиля, то есть имени, которое вы дали входу на один портал, вы решаете, что агент может только читать, +что сначала спрашивает вас и что выполняется сразу. Вы можете запретить агенту двигать или удалять сделки и знаете, +какие проверки действуют независимо от настроек. + +У каждой команды есть ключ прав: ее имя, например `deals.move`, или группа, например `deals`, и более длинный ключ +побеждает. У каждого ключа есть уровень: `deny`, `readonly`, `ask` или `allow`. Их задает `b24 work config set`, а +`--dry-run` показывает, какие ключи проверяет команда. + +**На этой странице:** + +1. [Уровни](#the-levels) +2. [Что задано до ваших изменений](#what-is-set-before-you-change-anything) +3. [Одна команда может проверять несколько ключей](#one-command-can-check-several-keys) +4. [Смена стадии запускает роботов портала](#stage-changes-start-the-portals-robots) +5. [Агенты и MCP](#agents-and-mcp) +6. [Проверки, которые действуют независимо от разрешений](#checks-that-hold-whatever-the-permissions-say) ## Уровни diff --git a/translations/b24/roadmap.es.md b/translations/b24/roadmap.es.md index 7d08212b..b5c37f11 100644 --- a/translations/b24/roadmap.es.md +++ b/translations/b24/roadmap.es.md @@ -2,10 +2,19 @@ title: "Próximas mejoras" --- -Esta página reúne lo que está previsto para `b24` y todavía no tiene. Léela antes de montar una solución alternativa -para algo que falta: puede que ya esté en camino. El orden es aproximado y puede cambiar. Para proponer algo, abre una +Mira qué hace `b24` hoy y qué viene después, antes de montar una solución alternativa para algo que le falta. Puede +que ya esté en camino. + +Sabrás con qué partes de tu Bitrix24 puede trabajar ya un agente, y cuáles llegan en las próximas versiones. El orden +es aproximado y puede cambiar. Para proponer algo, abre una [issue en GitHub](https://github.com/WireCatLabs/bitrix24-cli/issues). +**En esta página:** + +1. [Qué funciona hoy](#what-works-today) +2. [Siguiente](#next) +3. [Más adelante](#later) + ## Qué funciona hoy `b24` inicia sesión en un portal de Bitrix24 con un webhook entrante, o con una aplicación local que creas en el @@ -18,8 +27,12 @@ los contactos como miembros de sus empresas, los contactos y responsables de las propia empresa con su línea jerárquica. `pipelines show` es el tablero del embudo de ventas: las negociaciones o los prospectos de cada etapa, con su número y su total en cada moneda. `deals list`, `leads list`, `people list` y `organizations list` imprimen una página como tabla CSV para una hoja de -cálculo con `--format csv`. `schedule` ejecuta `sync` con un temporizador. `b24 api` llega a cualquier método del portal por su nombre. Todos los comandos están en -la [referencia de comandos](./commands.md). +cálculo con `--format csv`. `schedule` ejecuta `sync` con un temporizador. `changes list` muestra qué cambió en la copia, y `--format +report` lo convierte en un resumen matutino. Con `activities` activado, la sincronización también lee las llamadas, los correos, +las tareas pendientes, las tareas y los comentarios de negociaciones y prospectos. `meetings sync` copia las llamadas +del portal, `meetings transcribe` convierte sus grabaciones en texto en este ordenador, y `calls export` escribe en +Bitrix24 las llamadas de otros sistemas telefónicos. `b24 api` llega a cualquier método del portal por su nombre. +Todos los comandos están en la [referencia de comandos](./commands.md). ## Siguiente @@ -27,6 +40,8 @@ la [referencia de comandos](./commands.md). negociaciones y los prospectos, así que leen del almacén local y funcionan sin conexión. - **Campos propios de los contactos guardados en local.** Los valores de los campos propios de tu portal en los contactos se guardan con el contacto, para que puedas leerlos sin conexión. +- **Archivos y documentos de clientes.** Los archivos de las negociaciones y sus adjuntos, y los documentos creados con + las plantillas del portal. La configuración ya pide los permisos `disk` y `documentgenerator` que necesitan. ## Más adelante diff --git a/translations/b24/roadmap.ru.md b/translations/b24/roadmap.ru.md index 4925b830..bbe4f5b3 100644 --- a/translations/b24/roadmap.ru.md +++ b/translations/b24/roadmap.ru.md @@ -2,9 +2,18 @@ title: "Планы развития" --- -Здесь перечислено то, что запланировано для `b24`, но еще не сделано. Прочитайте эту страницу, прежде чем строить -обходной путь для недостающей возможности: возможно, она уже в работе. Порядок примерный и может меняться. Чтобы -что-то предложить, создайте [issue на GitHub](https://github.com/WireCatLabs/bitrix24-cli/issues). +Посмотрите, что `b24` умеет сегодня и что появится дальше, прежде чем строить обходной путь для того, чего в нем нет. +Возможно, это уже в работе. + +Вы узнаете, с какими частями вашего Битрикс24 агент может работать уже сейчас, а какие появятся в следующих версиях. +Порядок примерный и может меняться. Чтобы что-то предложить, создайте +[issue на GitHub](https://github.com/WireCatLabs/bitrix24-cli/issues). + +**На этой странице:** + +1. [Что работает уже сейчас](#what-works-today) +2. [Дальше](#next) +3. [Позже](#later) ## Что работает уже сейчас @@ -17,7 +26,10 @@ title: "Планы развития" контакты и ответственных у сделок, сотрудников вашей компании и кому они подчиняются. `pipelines show` показывает доску воронки продаж: сделки или лиды каждой стадии, их число и сумму в каждой валюте. `deals list`, `leads list`, `people list` и `organizations list` с `--format csv` печатают страницу как таблицу CSV для электронной таблицы. -`schedule` запускает `sync` по таймеру. `b24 api` вызывает любой метод портала по имени. Все команды есть в +`schedule` запускает `sync` по таймеру. `changes list` показывает, что изменилось в копии, а с `--format +report` это утренняя сводка. Если включен `activities`, синхронизация читает еще звонки, письма, дела, задачи и комментарии у +сделок и лидов. `meetings sync` копирует звонки портала, `meetings transcribe` превращает их записи в текст на этом +компьютере, а `calls export` записывает в Битрикс24 звонки из других телефонных систем. `b24 api` вызывает любой метод портала по имени. Все команды есть в [справочнике команд](./commands.md). ## Дальше @@ -26,6 +38,8 @@ title: "Планы развития" сделки и лиды, поэтому читают из локального хранилища и работают без сети. - **Собственные поля контактов в локальном хранилище.** Значения собственных полей вашего портала у контактов хранятся вместе с контактом, и их можно читать без сети. +- **Файлы и документы клиентов.** Файлы сделок и их вложения, а также документы, созданные по шаблонам портала. + Настройка уже запрашивает нужные для них права `disk` и `documentgenerator`. ## Позже diff --git a/translations/b24/security.es.md b/translations/b24/security.es.md index 033586a6..68ef8e9c 100644 --- a/translations/b24/security.es.md +++ b/translations/b24/security.es.md @@ -2,8 +2,31 @@ title: "Seguridad" --- -Lo que comparten las CLI de WireCat —el llavero, los permisos, MCP y lo que nunca llega a un registro— está en la -[página de seguridad común](https://wirecat.dev/en/docs/security). Esta página recoge solo lo propio de `b24`. +Deja que un agente trabaje en tu CRM mientras la dirección del webhook y los datos de contacto de tus clientes quedan +fuera de sus respuestas y de tus registros. La dirección del webhook es la contraseña del portal, así que cualquiera +que la lea puede hacer lo mismo que su empleado. + +Sabrás dónde guarda `b24` el inicio de sesión, qué llega al portal y a ningún otro sitio, y qué límites se mantienen +para un agente le digan lo que le digan. + +Lo que comparten las herramientas de WireCat, como el llavero, los permisos, MCP y lo que nunca llega a un registro, +está en la [página de seguridad común](https://wirecat.dev/en/docs/security). Esta página recoge solo lo propio de +`b24`. + +**En esta página:** + +1. [Dónde guarda cada cosa y con quién habla](#where-it-keeps-what-and-whom-it-talks-to) +2. [Los derechos del webhook](#the-webhooks-rights) +3. [Archivos y enlaces](#files-and-links) +4. [Teléfonos y correos de los clientes](#clients-phones-and-e-mails) +5. [Escrituras y búsqueda](#writes-and-search) +6. [api call](#api-call) +7. [Temporizadores](#timers) +8. [MCP en el navegador](#mcp-in-the-browser) +9. [Registros de ejecución](#run-records) +10. [Permisos de archivos](#file-modes) + +## Dónde guarda cada cosa y con quién habla `b24` guarda sus ajustes en `config.json` y su estado en las carpetas que muestra `b24 doctor`. Solo se comunica con el portal del webhook o de la aplicación local del perfil, y con `oauth.bitrix.info` para los tokens de la aplicación, @@ -25,8 +48,10 @@ que en tu navegador pasa el código de un solo uso a `b24` en este ordenador. El con la clave. Bitrix24 no tiene ninguna llamada que revoque un token: `session end` olvida el inicio de sesión aquí, y borrar la aplicación en el portal lo detiene. +## Los derechos del webhook + El webhook actúa con los derechos del empleado que lo creó. Un webhook creado por un administrador deja que un agente -lea y cambie todo el CRM. `session status --check` dice de quién son los derechos que lleva; crea el webhook con un +lea y cambie todo el CRM. `session status --check` dice de quién son los derechos que lleva. Crea el webhook con un empleado cuyos derechos se ajusten al trabajo, y solo con los permisos de acceso que necesita. `sync` usa `crm`, `user_basic` para las direcciones de correo de los empleados y `department` para la estructura de la empresa. `meetings sync` lee el historial de llamadas con `telephony`, y la grabación de una llamada solo con @@ -35,6 +60,8 @@ permiso completo `user` añade el derecho de invitarlos y editarlos. La sincroni de correo, el cargo y el jefe de departamento de cada empleado en el almacén local, donde cualquier herramienta de WireCat puede leerlos. +## Archivos y enlaces + Un archivo en un campo personalizado de un elemento del CRM se guarda solo como su id de archivo, en la copia y en cada respuesta, nunca sus enlaces: el enlace de descarga de Bitrix24 lleva un token de acceso, y quien lo tenga obtiene el archivo. Un archivo sin id y un enlace al portal con un token dentro (`/rest/…?auth=`, el @@ -48,6 +75,8 @@ lleva hecho. Un elemento borrado en el portal, o fuera del alcance de la sincron volver a iniciar sesión la crea de nuevo. SQLite puede conservar bytes antiguos en el espacio libre del archivo del almacén hasta que lo reutilice. +## Teléfonos y correos de los clientes + Salvo que el usuario del webhook sea administrador de Bitrix24, la sincronización copia solo sus propios clientes: los contactos y las empresas asignados a él o nombrados en sus negociaciones y prospectos. Las listas muestran teléfonos y correos solo de esos. `people @@ -55,21 +84,28 @@ show` y `organizations show` los dan para los de otros, como mucho 100 al día e cuenta se lleva en este ordenador, así que frena un descuido o a un agente, no a alguien que quiera llevarse la base. Eso lo hacen los propios derechos de acceso de Bitrix24. +## Escrituras y búsqueda + Cada escritura se comprueba contra los permisos y se guarda en el diario de envíos. `B24_READ_ONLY=1` rechaza toda escritura. Asignar un elemento a otro empleado se rechaza hasta que lo permitas. Un cambio de etapa aún puede poner en marcha los robots del propio portal, que pueden escribir a tus clientes. Si tu portal tiene esos robots, pon `permissions.deals.move` y `permissions.leads.move` en `readonly` o `deny` antes de que un agente reciba el perfil por MCP, donde `ask` no pregunta ([permisos](./permissions.md#stage-changes-start-the-portals-robots)). Toda escritura que fija una etapa los -comprueba; una etapa ganada o perdida, y `close`, comprueban además `deals.close` o `leads.close`, y `api call` con un +comprueba. Una etapa ganada o perdida, y `close`, comprueban además `deals.close` o `leads.close`, y `api call` con un `stageId` comprueba ambos. Se rechaza un `--field` de negociación o prospecto que nombra una etapa, un embudo o un responsable. Borrar una negociación o un prospecto pregunta antes. `api.crm.deal.update: deny` también detiene `deals update`, `move` y `close`, y en `ask` también preguntan. +Una escritura que no recibió respuesta no se vuelve a enviar: queda como `outcome_unknown` con su `operation_id`. +Comprueba el portal y repítela solo si el cambio no está: Bitrix24 haría la repetición por segunda vez. + `search all` lee lo que permiten las claves de las listas: con `deals.list: deny` deja fuera las negociaciones, con `leads.list: deny` los prospectos, y nombra cada tipo que dejó fuera en `missing` y en stderr. Si se le niegan todos los tipos que se le pidieron, se rechaza. +## api call + `api call` funciona con una lista de permitidos. Permite las lecturas de CRM, catálogo, usuarios y departamentos que hace el propio `b24`, y las escrituras de negociaciones, prospectos, contactos y empresas. Las lecturas de contactos, empresas y prospectos son solo de un administrador, digan lo que digan los permisos. Tanto las lecturas como las @@ -86,6 +122,8 @@ generados, `crm.invoice.getExternalLink`, `salescenter.payment.getPublicUrl`), ` También se rechazan sus lecturas, porque contienen mensajes, correos y tareas. `api show ` indica el nivel de un método. `api call` no se ofrece por MCP. +## Temporizadores + `schedule command` instala un temporizador (systemd, launchd o el Programador de tareas) que ejecuta `b24` por su cuenta, sin terminal. El temporizador ejecuta `b24 schedule exec `, y el archivo de la programación, en la carpeta de estado, guarda las palabras, el perfil, tu `PATH` y las carpetas que usa `b24` (`B24_CONFIG_DIR`, @@ -94,14 +132,15 @@ carpeta de estado, guarda las palabras, el perfil, tu `PATH` y las carpetas que `schedule exec`, cada uno con su propia clave de permiso (`schedule.run`, `schedule.exec`). Añadir, pausar, reanudar o quitar un temporizador por MCP se rechaza salvo que el perfil ponga `permissions.mcp.authority` en `allow`. -Una escritura que no recibió respuesta no se vuelve a enviar: queda como `outcome_unknown` con su `operation_id`. -Comprueba el portal y repítela solo si el cambio no está: Bitrix24 haría la repetición por segunda vez. +## MCP en el navegador `b24 work mcp serve --http` escucha solo en `127.0.0.1`, para aplicaciones del navegador que llegan a él a través de tu propio túnel. Cada aplicación inicia sesión con un código de un solo uso, y el servidor guarda un hash de cada inicio de sesión que concede, en la carpeta de estado, que solo tú puedes leer. `b24 work mcp revoke` los olvida todos. +## Registros de ejecución + Un registro de ejecución guarda la línea de comandos tal como la escribiste, así que `b24 runs show` te dice qué se ejecutó. Aun así, un secreto se guarda como `[redacted]`: una opción con nombre de token o de contraseña, una contraseña en un enlace, una cadena opaca larga. Un número de teléfono se sustituye por `[redacted]` dentro de la palabra que @@ -119,6 +158,8 @@ espacio (`pin this message` se queda), una clave hexadecimal en mayúsculas, un contraseña corta escrita sin el nombre de un secreto delante, y un secreto dentro de un enlace o de una ruta de archivo, salvo que tenga un formato conocido o vaya tras el nombre de un secreto. +## Permisos de archivos + `config.json` se guarda de modo que solo tú puedas leerlo (`0600`), y su carpeta se crea solo para ti (`0700`). Un archivo o una carpeta que creó una versión anterior puede estar abierto a otros usuarios del ordenador: `b24 doctor` muestra cada uno en `files.problems` e imprime el `chmod` que lo corrige. En Windows no se comprueba. Informa de una diff --git a/translations/b24/security.ru.md b/translations/b24/security.ru.md index 0d120dfc..06e76994 100644 --- a/translations/b24/security.ru.md +++ b/translations/b24/security.ru.md @@ -2,8 +2,31 @@ title: "Безопасность" --- -Общее для всех CLI WireCat — связка ключей, права, MCP и то, что никогда не попадает в журнал, — описано на -[общей странице о безопасности](https://wirecat.dev/en/docs/security). Здесь только то, что относится именно к `b24`. +Дайте агенту работать в вашей CRM так, чтобы адрес вебхука и контакты ваших клиентов не попадали в его ответы и в +ваши журналы. Адрес вебхука это пароль от портала, поэтому любой, кто его прочитает, может делать то же, что и его +сотрудник. + +Вы узнаете, где `b24` хранит вход, что уходит на портал и больше никуда и какие ограничения действуют для агента, +что бы ему ни сказали. + +Общее для всех инструментов WireCat, например связка ключей, права, MCP и то, что никогда не попадает в журнал, +описано на [общей странице о безопасности](https://wirecat.dev/en/docs/security). Здесь только то, что относится +именно к `b24`. + +**На этой странице:** + +1. [Где что хранится и с кем он говорит](#where-it-keeps-what-and-whom-it-talks-to) +2. [Права вебхука](#the-webhooks-rights) +3. [Файлы и ссылки](#files-and-links) +4. [Телефоны и почта клиентов](#clients-phones-and-e-mails) +5. [Запись и поиск](#writes-and-search) +6. [api call](#api-call) +7. [Таймеры](#timers) +8. [MCP в браузере](#mcp-in-the-browser) +9. [Записи запусков](#run-records) +10. [Права на файлы](#file-modes) + +## Где что хранится и с кем он говорит `b24` хранит настройки в `config.json`, а состояние — в папках, которые показывает `b24 doctor`. Он обращается только к порталу вебхука или локального приложения профиля и к `oauth.bitrix.info` за токенами приложения, по HTTPS, и @@ -23,8 +46,10 @@ title: "Безопасность" `b24` на этом компьютере. Код действует 30 секунд и только вместе с ключом. В Битрикс24 нет вызова, который отзывает токен. `session end` забывает вход здесь, а удаление приложения на портале останавливает его. +## Права вебхука + Вебхук действует с правами сотрудника, который его создал. Вебхук, созданный администратором, позволяет агенту -читать и менять все в CRM. `session status --check` показывает, чьи права у вебхука; создавайте вебхук от +читать и менять все в CRM. `session status --check` показывает, чьи права у вебхука. Создавайте вебхук от сотрудника, чьи права подходят для работы, и только с нужными scope. `sync` использует `crm`, `user_basic` для адресов почты сотрудников и `department` для структуры компании. `meetings sync` читает историю звонков через `telephony`, а запись звонка только при включенном `download_recordings` ([Звонки](./calls.md)). `user_basic` достаточно, потому @@ -32,6 +57,8 @@ title: "Безопасность" Синхронизация хранит имя, адрес почты, должность и руководителя отдела каждого сотрудника в локальном хранилище, где их читает любой инструмент WireCat. +## Файлы и ссылки + Файл в пользовательском поле записи CRM хранится только как id файла, в копии и в каждом ответе, без ссылок на него: ссылка Битрикс24 на скачивание несет токен доступа, и любой, у кого она есть, получает файл. Файл без id и ссылка на портал с токеном внутри (`/rest/…?auth=`, `/rest///` вебхука) показываются как `[link removed]`. Адрес @@ -44,6 +71,8 @@ title: "Безопасность" синхронизация после нового входа строит ее заново. SQLite может хранить старые байты в свободном месте файла хранилища, пока не использует это место снова. +## Телефоны и почта клиентов + Если пользователь вебхука не администратор Битрикс24, синхронизация копирует только его собственных клиентов, то есть контакты и компании, назначенные на него или указанные в его сделках и лидах. Списки показывают телефоны и почту только у них. `people @@ -51,21 +80,28 @@ show` и `organizations show` дают их и для чужих, не боль счетчик хранится на этом компьютере, поэтому он остановит случайность или агента, но не того, кто хочет забрать базу. Это делают права доступа самого Битрикс24. +## Запись и поиск + Каждая запись проверяется по правам и сохраняется в журнале отправок. `B24_READ_ONLY=1` отклоняет любую запись. Назначение записи другому сотруднику отклоняется, пока вы его не разрешите. Смена стадии все равно может запустить собственных роботов портала, которые могут написать вашим клиентам. Если на вашем портале есть такие роботы, задайте `permissions.deals.move` и `permissions.leads.move` как `readonly` или `deny` до того, как агент получит профиль через MCP, где `ask` ничего не спрашивает ([разрешения](./permissions.md#stage-changes-start-the-portals-robots)). Каждая запись, которая задает -стадию, проверяет их; стадия успеха или провала и `close` проверяют еще и `deals.close` или `leads.close`, а +стадию, проверяет их. Стадия успеха или провала и `close` проверяют еще и `deals.close` или `leads.close`, а `api call` со `stageId` проверяет оба. `--field` сделки или лида, который называет стадию, воронку или ответственного, отклоняется. Удаление сделки или лида сначала спрашивает. `api.crm.deal.update: deny` останавливает и `deals update`, `move` и `close`, а при `ask` они тоже спрашивают. +Запись, на которую не пришел ответ, не отправляется снова: она становится `outcome_unknown` со своим +`operation_id`. Проверьте портал и повторите ее, только если ее там нет: Битрикс24 выполнит повтор второй раз. + `search all` читает то, что разрешают ключи списков: при `deals.list: deny` он не берет сделки, при `leads.list: deny` лиды, и называет каждый пропущенный вид в `missing` и в stderr. Если запрещены все виды, о которых его спросили, он отклоняется. +## api call + `api call` работает по списку разрешенного. Он разрешает чтение CRM, каталога, пользователей и отделов, которое делает сам `b24`, и запись сделок, лидов, контактов и компаний. Чтение контактов, компаний и лидов доступно только администратору, что бы ни говорили разрешения. И чтение, и запись проверяют ключ команды, которая читает или @@ -80,6 +116,8 @@ CRM, задачи, `user.add`, публичные ссылки на файлы Их чтение тоже отклоняется, потому что в них лежат сообщения, письма и задачи. `api show ` называет уровень метода. `api call` не предлагается через MCP. +## Таймеры + `schedule command` ставит таймер (systemd, launchd или Планировщик заданий), который запускает `b24` сам, без терминала. Таймер запускает `b24 schedule exec `, а файл расписания в папке состояния хранит слова команды, профиль, ваш `PATH` и папки, которые использует `b24` (`B24_CONFIG_DIR`, `B24_STATE_DIR`, `MESSAGING_STORE`), но @@ -88,13 +126,14 @@ CRM, задачи, `user.add`, публичные ссылки на файлы каждую под своим ключом прав (`schedule.run`, `schedule.exec`). Добавление, приостановка, возобновление или удаление таймера через MCP отклоняются, если профиль не задает `permissions.mcp.authority` равным `allow`. -Запись, на которую не пришел ответ, не отправляется снова: она становится `outcome_unknown` со своим -`operation_id`. Проверьте портал и повторите ее, только если ее там нет: Битрикс24 выполнит повтор второй раз. +## MCP в браузере `b24 work mcp serve --http` слушает только на `127.0.0.1`, для браузерных приложений, которые подключаются к нему через ваш собственный туннель. Каждое приложение входит по одноразовому коду, а сервер хранит хеш каждого выданного входа в папке состояния, доступной для чтения только вам. `b24 work mcp revoke` забывает их все. +## Записи запусков + Запись запуска хранит командную строку в том виде, как вы ее ввели, поэтому `b24 runs show` показывает, что было запущено. Секрет при этом сохраняется как `[redacted]`: параметр с именем вроде token или password, пароль в ссылке, длинная непрозрачная строка. Номер телефона заменяется на `[redacted]` внутри введенного слова, включая текст @@ -111,6 +150,8 @@ CRM, задачи, `user.add`, публичные ссылки на файлы секрета перед ним, и секрет внутри ссылки или пути к файлу, если он не известного формата и не стоит после имени секрета. +## Права на файлы + `config.json` сохраняется доступным для чтения только вам (`0600`), а его папка создается только для вас (`0700`). Файл или папка, созданные старой версией, могут быть открыты другим пользователям компьютера: `b24 doctor` выводит каждый такой путь в `files.problems` и печатает `chmod`, который это исправляет. В Windows это не проверяется. Об diff --git a/translations/b24/troubleshooting.es.md b/translations/b24/troubleshooting.es.md index 54e0191e..7f1cde2f 100644 --- a/translations/b24/troubleshooting.es.md +++ b/translations/b24/troubleshooting.es.md @@ -2,8 +2,30 @@ title: "Cuando algo falla" --- -Empieza por el síntoma, haz la comprobación y vuelve a ejecutar el comando. Guarda el código de error y el nombre del -perfil para una solicitud de soporte. +Vuelve a poner `b24` en marcha a partir del síntoma que ves. La mayoría de los fallos vienen del inicio de sesión, +de un permiso de acceso (scope) que le falta al webhook o de los permisos del perfil, y cada uno tiene una comprobación +que nombra la causa. + +Busca tu síntoma en la tabla, haz la comprobación que indica y vuelve a ejecutar el comando. Si sigue fallando, ya +tienes el código de error y el nombre del perfil para una solicitud de soporte. + +`b24 doctor` muestra qué está configurado sin red ni llavero. `b24 work session status --check` pregunta al portal +con qué empleado actúa el webhook. + +**En esta página:** + +1. [Primeras comprobaciones](#first-checks) +2. [Síntomas y qué hacer](#symptoms-and-what-to-do) +3. [Pedir ayuda](#ask-for-help) + +## Primeras comprobaciones + +```sh +b24 doctor # the version, the settings, the profiles, without the network +b24 work session status --check # the employee the webhook acts as, and whether they are an admin +``` + +## Síntomas y qué hacer | Síntoma | Qué hacer | | --- | --- | @@ -18,8 +40,12 @@ perfil para una solicitud de soporte. | Falta el permiso de acceso para un método, o `ERROR_METHOD_NOT_FOUND` | Añade el permiso de acceso (`crm`, `user_basic`, `department`, y `telephony` para `meetings sync`) al webhook en Bitrix24: Developer resources → Integrations, edita el webhook. | | "this webhook may not read who made it" al iniciar sesión | Marca "Users (basic)" (`user_basic`) en el webhook, guarda y ejecuta `session start` otra vez con la dirección que muestra. Consulta [iniciar sesión](./usage.md#sign-in). | | "already uses this webhook" al iniciar sesión | Otro perfil lo tiene. Usa ese perfil, o quita ese perfil con `b24 account remove --keep-data` y vuelve a iniciar sesión. | -| `rate_limited` | El portal permite unas 2 peticiones por segundo para todas sus aplicaciones juntas. `b24` espera por sí mismo una espera corta; si es larga, te avisa. | +| `rate_limited` | El portal permite unas 2 peticiones por segundo para todas sus aplicaciones juntas. `b24` espera por sí mismo una espera corta y te avisa si es larga. | | `outcome_unknown` en una escritura | Puede que el portal hiciera el cambio. Mira primero el elemento (`sync` y luego `show`), y repite la escritura solo si el cambio no está: Bitrix24 haría la repetición por segunda vez. Consulta [escribir](./usage.md#write). | -| Se rechaza una escritura | Lo impiden los permisos del perfil o `B24_READ_ONLY`; consulta los [permisos](./permissions.md). | +| Se rechaza una escritura | Lo impiden los permisos del perfil o `B24_READ_ONLY`. Consulta los [permisos](./permissions.md). | + +## Pedir ayuda -Nunca pegues un token, una contraseña ni contenido privado en una solicitud de soporte. +Pregunta en [Discord](https://discord.gg/DebENqbRrJ) o abre una [issue](https://github.com/WireCatLabs/bitrix24-cli/issues) +con el código de error, el nombre del perfil y el comando. Nunca pegues un token, una contraseña ni contenido privado +en una solicitud de soporte. diff --git a/translations/b24/troubleshooting.ru.md b/translations/b24/troubleshooting.ru.md index 3a04d669..c077c59e 100644 --- a/translations/b24/troubleshooting.ru.md +++ b/translations/b24/troubleshooting.ru.md @@ -2,8 +2,29 @@ title: "Если что-то пошло не так" --- -Найдите симптом, выполните проверку, затем повторите команду. Для обращения в поддержку сохраните код ошибки и имя -профиля. +Верните `b24` в строй, начав с симптома, который видите. Чаще всего сбой идет от входа, от права (scope), которого +нет у вебхука, или от прав профиля, и для каждого случая есть проверка, которая называет причину. + +Найдите свой симптом в таблице, выполните проверку из нее и повторите команду. Если не помогло, у вас уже есть код +ошибки и имя профиля для обращения в поддержку. + +`b24 doctor` показывает, что настроено, без сети и без связки ключей. `b24 work session status --check` спрашивает у +портала, от имени какого сотрудника действует вебхук. + +**На этой странице:** + +1. [Первые проверки](#first-checks) +2. [Симптомы и что делать](#symptoms-and-what-to-do) +3. [Где спросить](#ask-for-help) + +## Первые проверки + +```sh +b24 doctor # the version, the settings, the profiles, without the network +b24 work session status --check # the employee the webhook acts as, and whether they are an admin +``` + +## Симптомы и что делать | Симптом | Что делать | | --- | --- | @@ -18,8 +39,12 @@ title: "Если что-то пошло не так" | Нет scope для метода, или `ERROR_METHOD_NOT_FOUND` | Добавьте scope (`crm`, `user_basic`, `department`, и `telephony` для `meetings sync`) к вебхуку в Битрикс24: «Разработчикам → Интеграции», изменить вебхук. | | "this webhook may not read who made it" при входе | Отметьте у вебхука право «Пользователи (базовый)» (`user_basic`), сохраните и снова запустите `session start` с адресом, который он показывает. См. [вход](./usage.md#sign-in). | | "already uses this webhook" при входе | Этот вебхук уже у другого профиля. Используйте тот профиль или удалите его командой `b24 account remove --keep-data` и войдите снова. | -| `rate_limited` | Портал разрешает около 2 запросов в секунду на все свои приложения вместе. Короткое ожидание `b24` выжидает сам; о долгом он сообщает вам. | +| `rate_limited` | Портал разрешает около 2 запросов в секунду на все свои приложения вместе. Короткое ожидание `b24` выжидает сам, а о долгом сообщает вам. | | `outcome_unknown` при записи | Портал мог внести изменение. Сначала посмотрите запись (`sync`, затем `show`) и повторите ее, только если ее там нет: Битрикс24 выполнит повтор второй раз. См. [запись](./usage.md#write). | -| Запись отклонена | Ее запрещают права профиля или `B24_READ_ONLY`, см. [права](./permissions.md). | +| Запись отклонена | Ее запрещают права профиля или `B24_READ_ONLY`. См. [права](./permissions.md). | + +## Где спросить -Никогда не вставляйте в обращение в поддержку токен, пароль или личное содержимое. +Спросите в [Discord](https://discord.gg/DebENqbRrJ) или откройте [issue](https://github.com/WireCatLabs/bitrix24-cli/issues) +с кодом ошибки, именем профиля и командой. Никогда не вставляйте в обращение в поддержку токен, пароль или личное +содержимое. diff --git a/translations/b24/usage.es.md b/translations/b24/usage.es.md index 21010977..50703929 100644 --- a/translations/b24/usage.es.md +++ b/translations/b24/usage.es.md @@ -2,7 +2,28 @@ title: "Uso" --- -Esta página explica cómo se construye un comando y cómo usa la herramienta un agente. Léela antes de tu primer comando. +Encuentra una negociación, muévela o mira qué cambió durante la noche con un comando corto, el mismo que ejecuta tu +agente. La API REST de Bitrix24 habla con nombres de métodos, códigos de campo como `UF_CRM_…` e ids de etapa como +`C1:WON`, y `b24` acepta en su lugar nombres de etapa y etiquetas de campo. + +Encuentras las negociaciones atascadas en una etapa, o cierras una como ganada, en una línea. Un agente hace lo mismo +a partir de lo que le pides. + +Cada comando empieza por un perfil, el nombre que diste al inicio de sesión de un portal. `sync` copia tus +negociaciones y prospectos al almacén local de WireCat, donde los encuentran las lecturas. `api call` llega a +cualquier otro método de Bitrix24. Necesitas un perfil con la sesión iniciada: [instalar](./installation.md) te +prepara uno. + +**En esta página:** + +1. [El perfil va primero](#the-profile-comes-first) +2. [Iniciar sesión](#sign-in) +3. [Sincronizar](#sync) +4. [Leer](#read) +5. [Qué cambió](#what-changed) +6. [Escribir](#write) +7. [Salida para scripts](#output-for-scripts) +8. [Agentes](#agents) ## El perfil va primero @@ -43,7 +64,7 @@ la dirección se usa antes que cualquiera de los dos. La dirección es la contra que el empleado del webhook. `b24 work session status --check` muestra el empleado con el que actúa el webhook y si es administrador. -`b24 work session end` olvida la dirección en este ordenador; el webhook sigue en Bitrix24 hasta que lo borres allí. +`b24 work session end` olvida la dirección en este ordenador. El webhook sigue en Bitrix24 hasta que lo borres allí. `b24 session list` muestra los perfiles de este ordenador. Un webhook pertenece a un solo perfil. `session start` rechaza un webhook que ya usa otro perfil de este ordenador (el @@ -84,7 +105,7 @@ ordenador. Bitrix24 no permite revocarlos, así que para pararlos borra la aplic ```sh b24 work account remove --keep-data --dry-run # what it would remove and keep, changing nothing -b24 work account remove --keep-data # forget the profile; its copy of the portal stays searchable +b24 work account remove --keep-data # forget the profile, its copy of the portal stays searchable b24 work account remove --delete-data --yes # also delete the portal's deals, leads, contacts and companies ``` @@ -99,14 +120,14 @@ Las negociaciones, los prospectos, los embudos y las etapas se leen del almacén buscan todas las herramientas de WireCat. `sync` lo pone al día: ```sh -b24 work sync # what changed since the last sync; everything on the first one +b24 work sync # what changed since the last sync, everything on the first one b24 work sync --rescan # everything again, every id too b24 work store status # how far each kind is, and how many are stored ``` Una sincronización lee por la hora de cambio de cada elemento, con un solapamiento, así que un elemento que cambió mientras se ejecutaba vuelve a llegar la próxima vez. Una vez al día también lista todos los ids y marca como borrados -los que el portal ya no tiene; una lista que marcaría más de la mitad se retiene, porque un webhook que perdió sus +los que el portal ya no tiene. Una lista que marcaría más de la mitad se retiene, porque un webhook que perdió sus derechos no lista ninguno. Una sincronización se detiene antes de su plazo o de `--max-pages`, y la siguiente sigue desde ahí. @@ -122,7 +143,7 @@ Cualquier otro cliente lo encuentras en el propio portal. ```sh b24 work users list # who is who on the portal b24 work config set crm.bitrix24:example.bitrix24.ru.unassigned 3327 # copy the deals and leads of user 3327 -b24 work config set crm.bitrix24:example.bitrix24.ru.scope mine # the default; an old "all" is refused +b24 work config set crm.bitrix24:example.bitrix24.ru.scope mine # the default, an old "all" is refused b24 work people list name:ivan* # any contact, read from the portal now ``` @@ -294,14 +315,14 @@ b24 work people show "Anna Ivanova" # contacts and companies by id, `deals`, `leads`, `pipelines` y `stages` son los comandos de CRM que comparte WireCat: las mismas palabras, consulta y respuesta en todas las herramientas de CRM. Una negociación o un prospecto responde su `pipeline`, `stage`, `status`, -`close_date`, y `amount` como decimal en su `currency`; `--offline` lee lo mismo. Los prospectos de Bitrix24 no tienen +`close_date`, y `amount` como decimal en su `currency`. `--offline` lee lo mismo. Los prospectos de Bitrix24 no tienen embudos, así que están en un único embudo llamado `Leads`. `people`, `organizations` y `users` también son comandos de CRM compartidos y leen el propio portal, así que `--offline` los rechaza. Una persona u organización da los campos propios del portal en `provider_metadata`, cada uno por su código con su etiqueta. Un campo de lista da la etiqueta de su opción, y el id de la opción como `option_id`. El sector, los ingresos y la moneda de una empresa también están ahí. `b24 work fields list deals` muestra esos campos con su tipo y sus opciones, tal como los -guardó el último `sync`; `leads`, `people` y `organizations` funcionan igual. Sus listas también filtran por esos +guardó el último `sync`. `leads`, `people` y `organizations` funcionan igual. Sus listas también filtran por esos campos, por código o por etiqueta, cuando el portal puede filtrar por ellos, y `--json` puede añadirlos: ```sh @@ -319,6 +340,27 @@ contactos y empresas al día (UTC), contando juntos a ti y a tus agentes. Volver tus propios clientes nunca cuentan. La cuenta se guarda en este ordenador, así que protege de un descuido y de un agente, no de alguien que quiere llevarse la base. Para eso están los permisos de acceso del propio Bitrix24. +## Qué cambió + +`changes list` muestra lo que las sincronizaciones vieron cambiar en la copia: negociaciones y prospectos creados, +movidos, ganados, perdidos o pasados a otro responsable, actividades añadidas y hechas, y contactos nuevos, primero los +más recientes. Lee el último día salvo que `at:` diga otra cosa. + +```sh +b24 work changes list "at>=1d" +b24 work changes list change:won "at>=7d" --json +``` + +`--format report` convierte esa ventana en un resumen matutino. Si lo ejecuta una programación, cada resumen empieza +donde terminó el anterior: + +```sh +b24 work schedule command morning --at 08:00 -- changes list "at>=1d" --format report +``` + +La programación muestra cada resumen como un aviso en el escritorio. `--deliver-to` también te lo envía a Telegram o +a tu buzón de correo con tu propia herramienta `tg` o de correo, como muestra `b24 help schedule command`. + ## Escribir ```sh @@ -333,9 +375,9 @@ b24 work organizations update 9 --name "Example LLC" --field "Lead source=Fair" ``` Una escritura envía una petición y luego vuelve a leer el elemento en el almacén. `--stage` -recibe una etapa del propio embudo del elemento por nombre o id, y también comprueba la clave `move`; una etapa ganada o +recibe una etapa del propio embudo del elemento por nombre o id, y también comprueba la clave `move`. Una etapa ganada o perdida comprueba además la clave `close`. `close` lo mueve a la primera etapa ganada o perdida de su embudo. -`--field