@google-cloud/kcmd 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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,265 @@
-# Temporary Holding Version
+# Metadata as Code
 
-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.
+Metadata as Code is a Knowledge Catalog (Dataplex) provides data stewards and data producers and AI agents with a source code artifact-based UX for metadata management and context engineering.
+
+Users and agents can author, manage, and enrich metadata artifacts using developer-friendly workflows with version control and CI/CD. It provides a standard metadata format can be used by a variety of tools and agents.
+
+More details are in the [docs/concept.md](docs/concept.md).
+
+## Key Features
+
+* Intuitive human and agent-friendly representation of metadata as source code in YAML and markdown files. Artifacts are organized in a hierarchical manner mirroring the resource hierarchy of data and metadata assets.
+* Bi-directional sync between local workspace and catalog service.
+* Support for both 1st party and 3rd party metadata constructs.
+* Distributed as a TypeScript and Python libraries, a CLI tool (kcmd), and an MCP server for use in a variety of applications, agents and workflows.
+
+## Metadata Artifacts
+
+### Directory Layout
+Metadata is organized within a directory representing a resource such as a BigQuery Dataset, Dataplex EntryGroup etc.
+
+```
+path/to/root/
+├── catalog.yaml                       # Manifest and config directives
+└── catalog/                           # Contains the metadata snapshot
+    └── <dir1>/
+        └── <entry-id1>.yaml           # Entry
+        └── <dir2>/
+            ├── <entry-id2>.yaml       # Entry with sidecar markdown
+            └── <entry-id2>.aspect.md  # files
+```
+
+## Catalog Snapshot Files
+
+### Manifest File
+**catalog/catalog.yaml**
+```yaml
+scope: bq-dataset.prod-data.ecommerce
+
+aliases:
+  ca-guidelines:
+    aspect: data-agents-project.global.ca-guidelines
+  ecommerce:
+    aspect: data-agents-project.global.ecommerce
+
+snapshot:
+  entries:
+    - dataplex-types.global.bigquery-dataset
+    - dataplex-types.global.bigquery-table
+    - dataplex-types.global.bigquery-view
+  aspects:
+    - dataplex-types.global.overview
+    - dataplex-types.global.descriptions
+
+publishing:
+  aspects:
+    - dataplex-types.global.overview
+    - dataplex-types.global.descriptions
+```
+
+## Entry YAML File
+**catalog/prod-data.ecommerce/products.yaml**
+```yaml
+id: products
+type: bigquery-table
+
+resource:
+  name: projects/prod-data/datasets/ecommerce/tables/products
+  displayName: Products Table
+  description: All products in the catalog
+  labels:
+    env: prod
+  createTime: 2026-04-23T00:44:03Z
+  updateTime: 2026-04-23T00:44:03Z
+
+schema:
+  ...
+
+contacts:
+  ...
+```
+
+## Entry Sidecar Markdown File
+**catalog/prod-data.ecommerce/products.overview.md**
+
+```markdown
+---
+userManaged: true
+links:
+  ...
+---
+[overview.content]
+```
+
+## Usage
+
+### Library
+
+You can use the `@google-cloud/kcmd` library to programmatically interact with the catalog metadata.
+
+```bash
+npm install @google-cloud/kcmd
+```
+
+```typescript
+import * as kcmd from '@google-cloud/kcmd';
+
+// Creating a catalog manifest from scratch
+const manifest = new kcmd.CatalogManifest(...);
+manifest.save('/path/to/root');
+
+// Loading a catalog snapshot from the filesystem
+const snapshot = kcmd.CatalogSnapshot.fromPath('/path/to/root');
+
+// Pulling the latest metadata from the Catalog service.
+const pullResult = await snapshot.pull();
+if (pullResult.success) {
+  console.log('Metadata pulled successfully');
+}
+else {
+  console.error('Metadata pull failed:', pullResult.error);
+}
+
+// Pushing the modified metadata to the Catalog service.
+const pushResult = await snapshot.push();
+if (pushResult.success) {
+  console.log('Metadata pushed successfully');
+}
+else {
+  console.error('Metadata push failed:', pushResult.error);
+}
+```
+
+### CLI
+
+The package provides the `kcmd` CLI tool. This is distributed as a standalone binary.
+
+```bash
+# Initialize a new catalog snapshot for a bigquery dataset
+kcmd init --bigquery-dataset <projectId>.<datasetId>
+
+# Initialize a new catalog snapshot for multiple bigquery datasets
+kcmd init --bigquery-dataset <projectId>.<datasetId1> --bigquery-dataset <projectId>.<datasetId2>
+
+# Initialize a new catalog snapshot for a custom EntryGroup
+kcmd init --entry-group <projectId>.<locationId>.<entryGroupId>
+
+# Initialize a new catalog snapshot for a locally-authored Semantic Model.
+# The scope names the EntryGroup the model belongs to; the model is authored as
+# a single Apache Ossie document at
+# catalog/EntryGroups/<entryGroupId>/<model>.yaml.
+kcmd init --semantic-model <projectId>.<locationId>.<entryGroupId>
+
+# Initialize an OKF workspace for an EntryGroup (or --kb): the entries are kept
+# as an Open Knowledge Format bundle under bundle/, with entry links in
+# bundle/_links.yaml. init records `layout: okf` in catalog.yaml, and pull and
+# push read it, so they take no flag. The entry group may not exist yet;
+# `kcmd push` creates it as a context set.
+kcmd init --entry-group <projectId>.<locationId>.<entryGroupId> --format okf
+
+# Pull the latest catalog snapshot from the Knowledge Catalog service
+# Reports any conflicts if there are pending changes that have not been
+# pushed to the catalog.
+# Supports dry run with the --dry-run flag.
+# Pull fetches the aspects each entry's type requires. To pull only some entry
+# types, or other aspects, list them as project.location.type under
+# snapshot.entries and snapshot.aspects in catalog.yaml.
+# kcmd init lists dataplex-types.global.overview under snapshot.aspects for
+# knowledge base, entry group and BigQuery dataset scopes.
+kcmd pull
+
+# Check for local modifications
+kcmd status
+
+# Push local changes to the Knowledge Catalog service. Only pushes changes
+# made since the last pull, and if that metadata has not been modified within
+# catalog in the interim.
+# Supports dry run with the --dry-run flag.
+kcmd push
+```
+
+For the semantic-model scope, `kcmd push` deploys the model as a property graph
+(`CREATE OR REPLACE PROPERTY GRAPH`) to the backend each entry of the model's
+`deployments` list names in its `target`: **BigQuery Graph** or **Spanner
+Graph**. The same authored model deploys to either. Pass `--validate-only
+--print` to print the generated DDL without executing it. For a BigQuery
+target this path additionally reads the target dataset's metadata
+(`bigquery.datasets.get`) to pin the query job's processing location; the call
+degrades gracefully when the permission is absent, so a narrower service account
+still works but falls back to BigQuery's own location inference. Each dataset
+`source` is the table's GCP resource name, such as
+`bigquery.googleapis.com/projects/<p>/datasets/<d>/tables/<t>`.
+(A Spanner target names its tables inside one database. Spanner Graph has no
+`MEASURE`, so a Spanner deployment uses a profile that excludes every metric.)
+Spanner Graph needs an Enterprise or Enterprise Plus edition instance, or a free
+trial instance. Push refuses a Spanner target on a Standard edition instance
+before it writes anything.
+
+`kcmd push` publishes the model and its sibling profile files to Knowledge
+Catalog before deploying the selected `deployments` entries (see
+[Reference — `kcmd push`](docs/semantic-model/reference.md#push) for
+`--deployment`, `--no-deployment`, `--print`, and `--force-remove`, and
+[docs/semantic-model/](docs/semantic-model/README.md) for the full guide).
+
+NOTE: The CLI uses `gcloud` to obtain authentication tokens, so ensure you are authenticated via `gcloud auth application-default login`.
+
+#### Environment variables
+
+Two optional variables override where `kcmd` talks to the catalog. Both default
+to production, so you normally leave them unset. A third, `KC_V2_ASPECTS`, is a
+temporary escape hatch.
+
+| Variable | Effect |
+|----------|--------|
+| `DATAPLEX_ENDPOINT` | Base URL for the Knowledge Catalog (Dataplex) API. Defaults to `https://dataplex.googleapis.com`. Set it to reach a non-prod host. |
+| `KC_TYPE_PROJECT` | Project the built-in `semantic-*` system types are read from on a semantic-model push. Defaults to `dataplex-types`. |
+| `KC_V2_ASPECTS` | Push and pull use the second-generation Knowledge Catalog types by default. `KC_V2_ASPECTS=0` temporarily restores the first-generation path, which will be removed; any other value has no effect. |
+
+### MCP Server
+
+To use the Metadata as Code tools as MCP tools in an agentic system such as the Gemini CLI, add the following to your MCP settings file:
+
+```json
+{
+  "mcpServers": {
+    "kc-mac": {
+      "command": "kcmd",
+      "args": ["mcp", "--path", "/path/to/root"]
+    }
+  }
+}
+```
+
+The server offers the following tools: 
+
+| Tool             | Description                                           |
+|------------------|-------------------------------------------------------|
+| pull             | Pull the latest metadata from the Catalog service     |
+| push             | Push the modified metadata to the Catalog service     |
+| list-entries     | List entries in the catalog snapshot                  |
+| lookup-entry     | Lookup an entry and its metadata from the snapshot    |
+| modify-entry     | Modify an entry and its metadata in the snapshot      |
+
+NOTE: The server uses `gcloud` to obtain authentication tokens, so ensure you are authenticated via `gcloud auth application-default login`.
+
+## Developer Workflow
+
+### Setup
+
+```bash
+git clone https://github.com/googlecloudplatform/knowledge-catalog
+cd toolbox/mdcode
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm run test
+```