### Liam ERD CLI Quick Start Source: https://liam-docs-sigma.vercel.app/docs/cli The fastest way to get started with Liam ERD is using the interactive setup command. This command guides you through the initial configuration. ```bash npx @liam-hq/cli ``` -------------------------------- ### Getting Started: Public Project Setup Source: https://liam-docs-sigma.vercel.app/docs/ Instructions on how to set up a public project with Liam ERD. This section outlines the initial steps for users to begin visualizing their database schemas. ```javascript // Instructions for public project setup would go here. // Example: // const setupProject = (schemaPath) => { // console.log(`Setting up project with schema: ${schemaPath}`); // }; ``` -------------------------------- ### Interactive Setup Command Source: https://github.com/liam-hq/liam This command initiates an interactive setup process for the project using the @liam-hq/cli package. It's the recommended way to get started. ```shell npx @liam-hq/cli init ``` -------------------------------- ### Quick Start for Private Repositories Source: https://github.com/liam-hq/liam This command initiates the interactive setup for Liam ERD for private repositories. It uses the Liam CLI to guide the user through the configuration process. ```bash npx @liam-hq/cli init ``` -------------------------------- ### Initialize Liam ERD CLI Source: https://liam-docs-sigma.vercel.app/docs/cli Initializes the Liam ERD CLI for quick setup. This command guides the user through the initial configuration process. ```bash npx @liam-hq/cli init ``` -------------------------------- ### Initialize Private Project with LiamHQ CLI Source: https://liam-docs-sigma.vercel.app/docs/ This command initiates an interactive setup process for private or internal repositories. It guides the user through building a static version of their diagrams. Ensure you have Node.js and a package manager (npm, pnpm, yarn, or bun) installed. ```npm npx @liam-hq/cli init ``` ```pnpm npx @liam-hq/cli init ``` ```yarn npx @liam-hq/cli init ``` ```bun npx @liam-hq/cli init ``` -------------------------------- ### Initialize Liam Project with CLI Source: https://liam-docs-sigma.vercel.app/docs/ Use the Liam CLI to initialize a new project. This command will guide you through the setup process to create a static version of your diagrams. ```bash bun x @liam-hq/cli init ``` -------------------------------- ### Liam ERD CLI Initialization Source: https://liam-docs-sigma.vercel.app/docs/cli/ci-cd This command initiates the Liam ERD CLI, guiding the user through an interactive setup process to generate configuration files or GitHub Actions templates tailored to their project. ```bash npx @liam-hq/cli init ``` -------------------------------- ### Example Schema Files Source: https://liambx.com/ Examples of schema files that can be visualized by Liam ERD. ```text db/schema.rb structure.sql ``` -------------------------------- ### Interactive Private Project Setup Source: https://liam-docs-sigma.vercel.app/docs/ This section describes how to initiate an interactive setup for private repositories. It provides the command to run and mentions the availability of different package managers (npm, pnpm). ```javascript npm install # or pnpm install ``` -------------------------------- ### Install tbls Source: https://liam-docs-sigma.vercel.app/docs/parser/supported-formats/bigquery Instructions for installing the tbls tool. This is the first step in generating your database schema. ```bash Follow the installation instructions at https://github.com/k1LoW/tbls?tab=readme-ov-file#install ``` -------------------------------- ### Install Liam CLI with Bun Source: https://liam-docs-sigma.vercel.app/docs/cli This snippet demonstrates how to install and use the Liam CLI with the Bun runtime. It includes a command to serve the distribution files. ```bash bun x serve dist/ # or your custom output directory ``` -------------------------------- ### Install liambx_llms_txt with bun Source: https://liam-docs-sigma.vercel.app/docs/ Installs the liambx_llms_txt package using bun. This command fetches and installs the package and its dependencies. ```bash bun dlx @liam-hq/cli init ``` -------------------------------- ### Schema Visualization Example Source: https://liambx.com/ An example of a raw schema file that can be visualized by Liam ERD. ```ruby [](/erd/p/raw.githubusercontent.com/liam-hq/liam/b7b9228de8840eb4ac3ca8342ebbda6d611d7ae5/frontend/packages/db-structure/src/parser/schemarb/input/schema1.in.rb?showMode=ALL_FIELDS) ``` -------------------------------- ### Liam ERD CLI Usage Examples Source: https://liam-docs-sigma.vercel.app/docs/cli Examples demonstrating how to use the Liam ERD CLI for various tasks, including generating diagrams from GitHub repositories. ```bash npx @liam-hq/cli --from-github ``` -------------------------------- ### Install Liam ERD with Bun Source: https://liam-docs-sigma.vercel.app/docs/cli/ci-cd Installs the Liam ERD CLI using Bun. This command sets up the necessary tools to start generating ER diagrams. ```shell bun x @liam-hq/cli init ``` -------------------------------- ### Project README File (README.md) Source: https://github.com/liam-hq/liam The main README file for the project, providing an introduction, setup instructions, and usage guidelines. It serves as the primary entry point for new contributors and users. ```markdown # LiamBX LLMs TXT This project explores the capabilities of Large Language Models (LLMs) for text processing and generation. ## Features * Text summarization * Text generation * Sentiment analysis ## Setup 1. Clone the repository: ```bash git clone https://github.com/liam-hq/liam.git cd liam ``` 2. Install dependencies: ```bash npm install ``` 3. Run the application: ```bash npm start ``` ## Contributing See [CONTRIBUTING.md](/liam-hq/liam/blob/main/CONTRIBUTING.md) for details on how to contribute. ## License This project is licensed under the MIT License - see the [LICENSE](/liam-hq/liam/blob/main/LICENSE) file for details. ``` -------------------------------- ### Repository Platform Information Source: https://github.com/liam-hq/liam Details platform-specific information for cloning the repository, including desktop and IDE integration URLs, and zipball download links. ```json { "platformInfo": { "cloneUrl": "https://desktop.github.com", "showVisualStudioCloneButton": false, "visualStudioCloneUrl": "https://windows.github.com", "showXcodeCloneButton": false, "xcodeCloneUrl": "xcode://clone?repo=https%3A%2F%2Fgithub.com%2Fliam-hq%2Fliam", "zipballUrl": "/liam-hq/liam/archive/refs/heads/main.zip" } } ``` -------------------------------- ### Install Liam ERD with Yarn Source: https://liam-docs-sigma.vercel.app/docs/cli/ci-cd Installs the Liam ERD CLI using Yarn. This command sets up the necessary tools to start generating ER diagrams. ```shell yarn dlx @liam-hq/cli init ``` -------------------------------- ### SVG Icon Example Source: https://liam-docs-sigma.vercel.app/docs/contributing An example of an SVG icon definition, likely used within a UI component. It includes standard SVG attributes and nested path elements. ```svg ``` -------------------------------- ### Example: Prisma + GitHub Actions + Cloudflare Pages Source: https://liam-docs-sigma.vercel.app/docs/cli/ci-cd An advanced example demonstrating the use of Liam ERD with Prisma, GitHub Actions for automated diagram generation, and deployment to Cloudflare Pages. This setup allows for restricted access to diagrams via Cloudflare Access. ```shell Follow the on-screen prompts to set up Liam ERD quickly. ``` -------------------------------- ### Raw File URL Examples Source: https://liam-docs-sigma.vercel.app/docs/web/troubleshooting Examples of correctly formatted URLs for accessing raw files from various Git hosting platforms. These URLs are essential for fetching configuration files, database schemas, or other raw data directly. ```markdown https://gist.githubusercontent.com/username/gistid/raw/commitsha/filename.yml https://gitlab.com/username/repo/-/raw/main/db/schema.rb https://bitbucket.org/username/repo/raw/main/prisma.schema ``` -------------------------------- ### Nested Routing Example Source: https://liam-docs-sigma.vercel.app/docs/contributing Demonstrates a nested routing structure, where a parent route contains child routes. This is indicated by the presence of `parallelRouterKey` and the nesting of route definitions. ```javascript { "children": [ null, [ "$", "$1", "c", { "children": [ "__PAGE__", [ "$", "$1", "c", { "children": [ "$L1b", null, [ "$", "$L1c", null, { "children": [ "$L1d", "$L1e", [ "$", "$L1f", null, { "promise": "$@20" } ] ] } ] ] } ], null, false ] } ], null, false ] } ``` -------------------------------- ### GitHub Product Navigation Source: https://github.com/liam-hq/liam HTML structure for GitHub's product navigation menu, highlighting key features like Copilot, Spark, and Models. ```html ``` -------------------------------- ### CLI Package (@liam-hq/cli) Source: https://liam-docs-sigma.vercel.app/docs/contributing/repository-architecture Command-line tool for generating static ERD visualization files. Features interactive project setup via the 'init' command and static site generation with Vite. See: /docs/cli. ```bash #!/bin/bash # @liam-hq/cli # Command-line tool for generating static ERD visualization files. # Key Responsibilities: # - Interactive project setup via 'init' command # - Static site generation with Vite # Example usage: # Initialize a new project: # npx @liam-hq/cli init # Build the static site: # npx @liam-hq/cli build ``` -------------------------------- ### Next.js Client-Side Rendering Initialization Source: https://liam-docs-sigma.vercel.app/docs/contributing This JavaScript snippet demonstrates the client-side initialization for a Next.js application. It includes the setup for React fragments, client segment roots, and various JavaScript chunks required for routing and context providers like TreeContextProvider, NavProvider, Navbar, and SearchToggle. ```javascript self.__next_f=self.__next_f||[];self.__next_f.push([0]);self.__next_f.push([1,"1:\"$Sreact.fragment\"\n2:I[68271,[],\"ClientSegmentRoot\"]\n3:I[42584,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"298\",\"static/chunks/298-98417fb044d7bb2c.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"177\",\"static/chunks/app/layout-cf809cd4fafa7c85.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"default\"]\n4:I[13456,[],\"\"]\n5:I[61590,[],\"\"]\n7:I[50385,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"433\",\"static/chunks/433-2fc1979ddbb0e6e6.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"499\",\"static/chunks/app/docs/layout-c1f192421554bf25.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"TreeContextProvider\"]\n8:I[34415,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"433\",\"static/chunks/433-2fc1979ddbb0e6e6.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"499\",\"static/chunks/app/docs/layout-c1f192421554bf25.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"NavProvider\"]\n9:I[29121,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"433\",\"static/chunks/433-2fc1979ddbb0e6e6.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"499\",\"static/chunks/app/docs/layout-c1f192421554bf25.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"Navbar\"]\na:I[5282,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"870\",\"static/chunks/app/docs/%5B%5B...slug%5D%5D/page-fbcd51869567a22e.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"default\"]\nc:I[89719,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"433\",\"static/chunks/433-2fc1979ddbb0e6e6.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"499\",\"static/chunks/app/docs/layout-c1f192421554bf25.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"SearchToggle\"]\nd:I[29121,[\"445\",\"static/chunks/dcf0f0cd-6a91bc519e160ea7.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"444\",\"static/chunks/444-09eae9ce0c8a620b.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"982\",\"static/chunks/982-5547d34e446eb618.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"507\",\"static/chunks/507-a20e1e50d4871f76.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"433\",\"static/chunks/433-2fc1979ddbb0e6e6.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"413\",\"static/chunks/413-5bc39186cbd4bfc8.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\",\"499\",\"static/chunks/app/docs/layout-c1f192421554bf25.js?dpl=dpl_J5VpPYQQnjdk57MDdpouYUozrxbs\"],\"default\"]\n ``` -------------------------------- ### Project README Japanese (README.md) Source: https://github.com/liam-hq/liam Japanese version of the project's README file, providing an introduction, setup instructions, and usage guidelines in Japanese for Japanese-speaking users. ```markdown # LiamBX LLMs TXT このプロジェクトは、テキスト処理と生成のための大規模言語モデル（LLM）の機能を調査します。 ## 特徴 * テキスト要約 * テキスト生成 * 感情分析 ## セットアップ 1. リポジトリをクローンします： ```bash git clone https://github.com/liam-hq/liam.git cd liam ``` 2. 依存関係をインストールします： ```bash npm install ``` 3. アプリケーションを実行します： ```bash npm start ``` ## 貢献 貢献方法については、[CONTRIBUTING.md](/liam-hq/liam/blob/main/CONTRIBUTING.md) を参照してください。 ## ライセンス このプロジェクトはMITライセンスの下でライセンスされています。詳細は[LICENSE](/liam-hq/liam/blob/main/LICENSE)ファイルを参照してください。 ``` -------------------------------- ### Install liambx_llms_txt with pnpm Source: https://liam-docs-sigma.vercel.app/docs/ Installs the liambx_llms_txt package using pnpm. This command fetches and installs the package and its dependencies. ```bash pnpm dlx @liam-hq/cli init ``` -------------------------------- ### Install liambx_llms_txt with npm Source: https://liam-docs-sigma.vercel.app/docs/ Installs the liambx_llms_txt package using npm. This command fetches and installs the package and its dependencies. ```bash npx dlx @liam-hq/cli init ``` -------------------------------- ### Using the init Command Source: https://liam-docs-sigma.vercel.app/docs/cli/ci-cd This section refers to the usage of an 'init' command within the Liam ERD CLI, though specific details or examples for this command are not provided in the input text. ```bash liam init ``` -------------------------------- ### Install liambx_llms_txt with yarn Source: https://liam-docs-sigma.vercel.app/docs/ Installs the liambx_llms_txt package using yarn. This command fetches and installs the package and its dependencies. ```bash yarn dlx @liam-hq/cli init ``` -------------------------------- ### CI/CD Integration Source: https://liam-docs-sigma.vercel.app/docs/parser/troubleshooting Guide on integrating Liam ERD CLI with CI/CD pipelines. ```markdown CI/CD Integration Guide on integrating Liam ERD CLI with CI/CD pipelines. ``` -------------------------------- ### Serve Project Output Source: https://liam-docs-sigma.vercel.app/docs/cli Instructions on how to serve the generated project output using different package managers. This command is used to host the static files generated by the build process, allowing you to preview your project in a browser. ```bash npx serve dist/ # or your custom output directory ``` ```bash pnpm dlx serve dist/ # or your custom output directory ``` ```bash yarn serve dist/ # or your custom output directory ``` ```bash bun serve dist/ # or your custom output directory ``` -------------------------------- ### Serve Static Files with npm Source: https://liam-docs-sigma.vercel.app/docs/cli This snippet demonstrates how to serve static files from a 'dist/' directory using the 'serve' command with npm. It's a common way to quickly preview static web content. ```bash npx serve dist/ # or your custom output directory ```