@meada/meada 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,192 @@
-# Temporary Holding Version
+# Meada
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Português (Brasil)](README.md) · [English](README.en.md) · [Español](README.es.md)
+
+Meada lê os seus repositórios, monta o mapa de quem chama quem e costura um repositório no
+outro pelos contratos que eles compartilham: rotas HTTP, filas, pacotes, recursos compartilhados.
+Agentes de código, e gente também, consultam esse mapa por MCP. Nenhuma etapa da indexação usa
+LLM.
+
+## Instalação
+
+Escolha a linha que combina com o que você já tem. Todos os canais entregam o mesmo binário
+`meada`, e a última coluna é o comando que a configuração MCP do seu agente executa.
+
+| Você tem | Instalação | Comando do servidor MCP |
+| --- | --- | --- |
+| Node.js | nada: `npx -y @meada/meada --version` | `npx -y @meada/meada mcp` |
+| Rust | `cargo install meada` | `meada mcp` |
+| Linux ou macOS | o instalador de shell abaixo | `meada mcp` |
+| Qualquer sistema | o arquivo do seu sistema nas [releases do GitHub](https://github.com/ClaudioMascaro/meada/releases), com `meada` no `PATH` | `meada mcp` |
+| Docker | `docker pull ghcr.io/claudiomascaro/meada:1.0.0` | a linha `docker run` em [Conectar um agente](#conectar-um-agente-mcp) |
+
+```sh
+# Instalador de shell (Linux e macOS)
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ClaudioMascaro/meada/releases/latest/download/meada-installer.sh | sh
+```
+
+Os arquivos prontos cobrem Linux, macOS e Windows, em x86_64 e arm64; a imagem cobre Linux amd64
+e arm64. A versão do pacote npm é sempre a da release. Para indexar, o Meada só precisa do
+binário e do git. Os detalhes de cada canal, da console e do contêiner estão em
+[Instalação](https://claudiomascaro.github.io/meada/installation/) e no
+[guia do usuário](docs/user-guide.md) (seção 1, Instalação).
+
+## Primeiros passos
+
+Na raiz de um repositório (aqui `web`, que consome a rota de `api`):
+
+```sh
+meada index     # monta o índice em .meada/, do repositório e dos pares
+meada status    # o estado de cada índice e os pares não encontrados
+```
+
+Para o Meada ligar `web` a `api`, o `meada.toml` de `web` nomeia o par:
+
+```toml
+[[peer]]
+repo = "example.com/acme/api"       # remoto git de origin, sem esquema nem .git
+base_url_env = ["API_URL"]          # variável de onde o cliente lê a URL base
+```
+
+A referência completa do `meada.toml` está no
+[guia do usuário](docs/user-guide.md) (seção 4, referência do `meada.toml`).
+
+## Conectar um agente (MCP)
+
+O cliente executa o comando do servidor MCP e fala com o Meada por stdio. Na configuração do seu
+agente (por exemplo o `.mcp.json` do Claude Code), com npx:
+
+```json
+{
+  "mcpServers": {
+    "meada": { "command": "npx", "args": ["-y", "@meada/meada", "mcp"] }
+  }
+}
+```
+
+No Claude Code, o mesmo em uma linha: `claude mcp add meada -- npx -y @meada/meada mcp`. Com
+`meada` já no `PATH` (Cargo, instalador ou arquivo pronto), use
+`"command": "meada", "args": ["mcp"]`.
+
+Com Docker (Linux e macOS):
+
+```json
+{
+  "mcpServers": {
+    "meada": {
+      "command": "sh",
+      "args": ["-c", "exec docker run -i --rm --network none --user \"$(id -u):$(id -g)\" -v \"${PWD%/*}:${PWD%/*}\" -w \"$PWD\" ghcr.io/claudiomascaro/meada:1.0.0 mcp"]
+    }
+  }
+}
+```
+
+O cliente inicia o servidor no seu repositório. O Meada responde sobre o caminho que o cliente
+envia como raiz, então o contêiner monta a pasta que contém o repositório, e os pares vizinhos,
+nesse mesmo caminho; roda com o seu usuário, para o `.meada/` continuar seu, e sem rede, que nem
+a indexação nem o stdio usam.
+
+O agente ganha três ferramentas, `search`, `context` e `trace`, que só leem. Veja
+[Agentes e MCP](https://claudiomascaro.github.io/meada/mcp/) e o
+[guia do usuário](docs/user-guide.md) (seção 2, Conectar um agente).
+
+### Skill para agentes
+
+[`skills/meada/SKILL.md`](skills/meada/SKILL.md) ensina o agente a escolher cada ferramenta e a
+ler os níveis de uma resposta. No Claude Code:
+
+```sh
+mkdir -p ~/.claude/skills/meada
+curl -fsSL https://raw.githubusercontent.com/ClaudioMascaro/meada/v1.0.0/skills/meada/SKILL.md -o ~/.claude/skills/meada/SKILL.md
+```
+
+Outros agentes: veja [Agentes e MCP](https://claudiomascaro.github.io/meada/mcp/#skill-para-agentes).
+
+## Status
+
+Meada 1.0 entrega todo o escopo da v1 do [ADR 0003](docs/adr/0003-v1-scope-and-roadmap.md):
+
+- **Contratos**: rotas HTTP, recursos declarados, documentos OpenAPI e AsyncAPI, filas e
+  tópicos, pacotes.
+- **Níveis**: um nível em cada ligação, cadeias que atravessam repositórios e decisões com
+  decisor opcional (`meada decide`).
+- **Análises**: drift de forma, comunidades e processos.
+- **Linguagens no 1.0**: TypeScript e JavaScript, Python, Go e Rust. Java, Kotlin, C# e Swift
+  são trabalho planejado da Release 2 e chegam depois como versões 1.x (#26 a #29, ADR 0003).
+
+**Promessa de estabilidade.** A partir do 1.0 vale o semver: uma mudança incompatível em um
+destes itens pede uma versão major.
+
+- os nomes, os parâmetros e a gramática de saída das ferramentas MCP (`search`, `context` e
+  `trace` hoje);
+- os comandos e as flags da CLI;
+- os esquemas do `meada.toml` e do `meada.decisions.toml`;
+- o formato do `meada export`.
+
+Acrescentar uma ferramenta MCP, um parâmetro opcional, um valor aceito a um parâmetro, um tipo de
+busca, um campo no fim de uma linha da saída, uma chave de configuração, um campo do export ou
+uma linguagem é mudança menor. Não entram na promessa o texto das mensagens da CLI, o
+texto das descrições das ferramentas, o arquivo de índice e o layout de `.meada/` (reconstruídos
+quando o esquema muda) e quais ligações o Meada encontra num código (melhorar a resolução é
+correção, não quebra). O detalhe do que é congelado e do que não é está em
+[Estabilidade](https://claudiomascaro.github.io/meada/stability/).
+
+## Alimentar uma base de conhecimento
+
+`meada export` imprime o índice de um repositório como JSON ordenado, bom para `diff` e para
+alimentar uma base de conhecimento. Por repositório, ele traz os símbolos (identidade estável e
+span), as chamadas com seus níveis, provedores e consumidores, links, imports, comunidades,
+processos e pontos de entrada. Não traz texto-fonte: quem precisa do trecho lê o span no arquivo.
+
+Um registro por símbolo, com comunidade, quem chama e quem é chamado, contratos e processos:
+
+```sh
+meada export > web.export.json
+jq -c '. as $e | $e.symbols[] | .id as $id | {
+  id, hash, span,
+  community: ([$e.communities[]? | select(.members | index($id)) | .name] | first),
+  callers: [$e.calls[] | select(.target == $id) | .caller],
+  callees: [$e.calls[] | select(.caller == $id and .target) | .target],
+  contracts: ([($e.providers[]?, $e.consumers[]?) | select(.site | startswith($id + "::")) | .contract] | unique),
+  processes: [$e.processes[]? | select(any(.steps[]; .node == $id)) | .entry_point]
+}' web.export.json
+
+# duplicates: symbols that share a hash
+jq '[.symbols[] | {id, hash}] | group_by(.hash) | map(select(length > 1))' web.export.json
+```
+
+Um registro por comunidade (`communities`) ou por contrato (`providers`, `consumers`, `links`)
+segue as mesmas listas.
+
+- **Fan-in** entre repositórios: conte, por alvo, as `calls`, os `links` (pelo `provider`) e os
+  `imports` de todos os exports juntos.
+- **Exposição**: os pontos de entrada em `processes` (`route`, `export`, `channel`, `program`), os
+  nomes exportados e os consumidores de pacote (`packages`, `dependencies`, `imports`).
+
+```sh
+jq -s '[.[] | (.calls[]? | select(.target) | {site: .id, target, kind: "calls"}),
+              (.links[]? | {site: .consumer, target: .provider, kind: "links"}),
+              (.imports[]? | {site, target, kind: "imports"})]
+  | unique_by([.kind, .site, .target])
+  | group_by(.target)
+  | map(. as $g | {target: $g[0].target}
+      + ([$g[].kind] | group_by(.) | map({(.[0]): length}) | add))' *.export.json
+```
+
+O export é por repositório: uma organização roda `meada export` em cada um e junta os resultados
+pela identidade dos símbolos. Embeddings e qualquer etapa com modelo ficam a jusante, fora do
+Meada (invariante 1, [ADR 0002](docs/adr/0002-product-invariants.md)).
+
+## Documentação
+
+- [Guia do usuário](docs/user-guide.md)
+- [Configuração](https://claudiomascaro.github.io/meada/configuration/)
+- [Agentes e MCP](https://claudiomascaro.github.io/meada/mcp/)
+- [Modo servidor](https://claudiomascaro.github.io/meada/server/)
+- [Implantar com Docker, Compose ou Helm](https://claudiomascaro.github.io/meada/deploy/)
+- [Console](https://claudiomascaro.github.io/meada/console/)
+- [Capacidades e limites](https://claudiomascaro.github.io/meada/capabilities/)
+- [Estabilidade](https://claudiomascaro.github.io/meada/stability/)
+- [Participar](https://claudiomascaro.github.io/meada/contributing/)
+
+[Apache-2.0](LICENSE).