@gitlab/orbit 0.0.1 → 0.96.0

package/LICENSE.md

@@ -0,0 +1,44 @@
+The GitLab Enterprise Edition (EE) license (the “EE License”)
+Copyright (c) 2011-present GitLab Inc.
+
+With regard to the GitLab Software:
+
+This software and associated documentation files (the "Software") may only be
+used in production, if you (and any entity that you represent) have agreed to,
+and are in compliance with, the GitLab Subscription Terms of Service, available
+at https://about.gitlab.com/terms/#subscription (the “EE Terms”), or other
+agreement governing the use of the Software, as agreed by you and GitLab,
+and otherwise have a valid GitLab Enterprise Edition subscription for the
+correct number of user seats. Subject to the foregoing sentence, you are free to
+modify this Software and publish patches to the Software. You agree that GitLab
+and/or its licensors (as applicable) retain all right, title and interest in and
+to all such modifications and/or patches, and all such modifications and/or
+patches may only be used, copied, modified, displayed, distributed, or otherwise
+exploited with a valid GitLab Enterprise Edition subscription for the  correct
+number of user seats.  Notwithstanding the foregoing, you may copy and modify
+the Software for development and testing purposes, without requiring a
+subscription.  You agree that GitLab and/or its licensors (as applicable) retain
+all right, title and interest in and to all such modifications.  You are not
+granted any other rights beyond what is expressly stated herein.  Subject to the
+foregoing, it is forbidden to copy, merge, publish, distribute, sublicense,
+and/or sell the Software.
+
+This EE License applies only to the part of this Software that is not
+distributed as part of GitLab Community Edition (CE). Any part of this Software
+distributed as part of GitLab CE or is served client-side as an image, font,
+cascading stylesheet (CSS), file which produces or is compiled, arranged,
+augmented, or combined into client-side JavaScript, in whole or in part, is
+copyrighted under the MIT Expat license. The full text of this EE License shall
+be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+For all third party components incorporated into the GitLab Software, those
+components are licensed under the original license provided by the owner of the
+applicable component.

package/README.md

@@ -1,3 +1,34 @@
 # @gitlab/orbit
 
-Initial stub version.
+The [GitLab Knowledge Graph (Orbit)](https://gitlab.com/gitlab-org/orbit/knowledge-graph)
+local CLI. Indexes a repository on your machine into a local DuckDB property
+graph and answers code-structure queries (definitions, references, imports,
+files, directories) over it.
+
+## Install
+
+```shell
+npm install -g @gitlab/orbit
+```
+
+This wrapper package selects and installs the prebuilt binary for your
+platform via optional dependencies:
+
+- `@gitlab/orbit-darwin-arm64`
+- `@gitlab/orbit-darwin-x64`
+- `@gitlab/orbit-linux-arm64`
+- `@gitlab/orbit-linux-x64`
+- `@gitlab/orbit-win32-x64`
+
+Linux binaries are fully static (musl) and run on both glibc and musl
+distributions.
+
+## Usage
+
+```shell
+orbit index /path/to/your/repo
+orbit help
+```
+
+See the [Orbit Local documentation](https://docs.gitlab.com/orbit/local/getting-started/)
+for access methods (direct CLI, `glab`, MCP) and query examples.

package/bin/orbit.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+"use strict";
+
+const { spawnSync } = require("node:child_process");
+
+const packageName = `@gitlab/orbit-${process.platform}-${process.arch}`;
+const binaryName = process.platform === "win32" ? "orbit.exe" : "orbit";
+
+let binaryPath;
+try {
+  binaryPath = require.resolve(`${packageName}/${binaryName}`);
+} catch {
+  console.error(
+    `@gitlab/orbit: no prebuilt orbit binary for ${process.platform}-${process.arch}.\n` +
+      `The optional dependency ${packageName} is not installed. Reinstall without ` +
+      `--no-optional / --omit=optional, or use another install method: ` +
+      `https://docs.gitlab.com/orbit/local/getting-started/`
+  );
+  process.exit(1);
+}
+
+const result = spawnSync(binaryPath, process.argv.slice(2), {
+  stdio: "inherit",
+});
+
+if (result.error) {
+  console.error(`@gitlab/orbit: failed to run ${binaryPath}: ${result.error.message}`);
+  process.exit(1);
+}
+
+process.exit(result.status ?? 1);

package/package.json

@@ -1,8 +1,40 @@
 {
   "name": "@gitlab/orbit",
-  "description": "GitLab Orbit",
+  "version": "0.96.0",
+  "description": "GitLab Knowledge Graph (Orbit) local CLI",
+  "keywords": [
+    "gitlab",
+    "orbit",
+    "knowledge-graph",
+    "code-intelligence"
+  ],
   "author": "GitLab",
-  "license": "UNLICENSED",
-  "version": "0.0.1",
-  "files": []
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://gitlab.com/gitlab-org/orbit/knowledge-graph",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/gitlab-org/orbit/knowledge-graph.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/gitlab-org/orbit/knowledge-graph/-/issues"
+  },
+  "bin": {
+    "orbit": "bin/orbit.js"
+  },
+  "files": [
+    "bin/orbit.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "optionalDependencies": {
+    "@gitlab/orbit-darwin-arm64": "0.96.0",
+    "@gitlab/orbit-darwin-x64": "0.96.0",
+    "@gitlab/orbit-linux-arm64": "0.96.0",
+    "@gitlab/orbit-linux-x64": "0.96.0",
+    "@gitlab/orbit-win32-x64": "0.96.0"
+  }
 }