diff --git a/documentation/docs/cli/getting-started.md b/documentation/docs/cli/getting-started.md new file mode 100644 index 00000000..a4315dda --- /dev/null +++ b/documentation/docs/cli/getting-started.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 1 +sidebar_label: Installation +title: Bitloops CLI - How to Install Bitloops +description: This article explains how to install the open source Bitloops CLI and begin using it to build high-quality, robust, flexible and maintainable systems using your favourite AI agent. +keywords: + [ + bitloops, + software engineering, + coding, + software development, + AI, + AI coding, + AI development, + claude code, + cursor, + gemini, + opencode, + ] +--- + +# Installation + +Choose one of the following methods to install the Bitloops CLI. + +## Install with curl + +On Unix-like systems (Linux, macOS), you can install the CLI using the official install script: + +```bash +curl -sL https://bitloops.com/install.sh | bash +``` + +To uninstall: + +```bash +curl -sL https://bitloops.com/install.sh | bash -s -- --uninstall +``` + +:::tip +Downloading and running scripts from the internet can be a security risk. You may want to [download the script](https://bitloops.com/install.sh) first, review its contents, then run it with `bash install.sh`. +::: + +## Install with Homebrew + +If you use [Homebrew](https://brew.sh/) on macOS or Linux: + +```bash +brew install bitloops +``` + +If the formula is in a custom tap: + +```bash +brew tap bitloops/tap +brew install bitloops +``` + +## Install with Cargo + +If you have [Rust](https://www.rust-lang.org/tools/install) and Cargo installed, you can install the CLI from [crates.io](https://crates.io): + +```bash +cargo install bitloops +``` + +--- + +After installation, verify by running: + +```bash +bitloops --help +``` diff --git a/documentation/docs/cli/getting-started/installation.md b/documentation/docs/cli/getting-started/installation.md new file mode 100644 index 00000000..a4315dda --- /dev/null +++ b/documentation/docs/cli/getting-started/installation.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 1 +sidebar_label: Installation +title: Bitloops CLI - How to Install Bitloops +description: This article explains how to install the open source Bitloops CLI and begin using it to build high-quality, robust, flexible and maintainable systems using your favourite AI agent. +keywords: + [ + bitloops, + software engineering, + coding, + software development, + AI, + AI coding, + AI development, + claude code, + cursor, + gemini, + opencode, + ] +--- + +# Installation + +Choose one of the following methods to install the Bitloops CLI. + +## Install with curl + +On Unix-like systems (Linux, macOS), you can install the CLI using the official install script: + +```bash +curl -sL https://bitloops.com/install.sh | bash +``` + +To uninstall: + +```bash +curl -sL https://bitloops.com/install.sh | bash -s -- --uninstall +``` + +:::tip +Downloading and running scripts from the internet can be a security risk. You may want to [download the script](https://bitloops.com/install.sh) first, review its contents, then run it with `bash install.sh`. +::: + +## Install with Homebrew + +If you use [Homebrew](https://brew.sh/) on macOS or Linux: + +```bash +brew install bitloops +``` + +If the formula is in a custom tap: + +```bash +brew tap bitloops/tap +brew install bitloops +``` + +## Install with Cargo + +If you have [Rust](https://www.rust-lang.org/tools/install) and Cargo installed, you can install the CLI from [crates.io](https://crates.io): + +```bash +cargo install bitloops +``` + +--- + +After installation, verify by running: + +```bash +bitloops --help +``` diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js index 656e47b5..9703db25 100644 --- a/documentation/docusaurus.config.js +++ b/documentation/docusaurus.config.js @@ -36,22 +36,22 @@ const config = { [ '@docusaurus/plugin-content-docs', { - id: 'bitloops-language', - path: 'docs/bitloops-language', - routeBasePath: 'bitloops-language', // Adjusted - sidebarPath: require.resolve('./sidebarsBitloops.js'), - // editUrl: 'https://github.com/bitloops/bitloops-language/edit/main/documentation', + id: 'cli', + path: 'docs/cli', + routeBasePath: 'cli', // Adjusted + sidebarPath: require.resolve('./sidebarsCli.js'), + // disableVersioning: true, // optional, based on your preference + // You might want to add an edit URL for cli as well }, ], [ '@docusaurus/plugin-content-docs', { - id: 'design-2-code', - path: 'docs/design-2-code', - routeBasePath: 'design-2-code', // Adjusted - sidebarPath: require.resolve('./sidebarsDesign2Code.js'), - // disableVersioning: true, // optional, based on your preference - // You might want to add an edit URL for design-2-code as well + id: 'bitloops-language', + path: 'docs/bitloops-language', + routeBasePath: 'bitloops-language', // Adjusted + sidebarPath: require.resolve('./sidebarsBitloops.js'), + // editUrl: 'https://github.com/bitloops/bitloops-language/edit/main/documentation', }, ], // ... other plugins you might have diff --git a/documentation/package.json b/documentation/package.json index cd38e220..30dae5f0 100644 --- a/documentation/package.json +++ b/documentation/package.json @@ -1,6 +1,6 @@ { "name": "bitloops-com-docs", - "version": "0.0.3", + "version": "0.1.0", "scripts": { "docusaurus": "docusaurus", "start": "docusaurus serve --host 0.0.0.0 --port 8080", diff --git a/documentation/sidebarsCli.js b/documentation/sidebarsCli.js new file mode 100644 index 00000000..db889708 --- /dev/null +++ b/documentation/sidebarsCli.js @@ -0,0 +1,15 @@ +module.exports = { + bitloopsLanguageSidebar: [ + { + type: 'category', + label: 'Getting Started', + link: { + type: 'generated-index', + description: 'This section explains how to install the Bitloops CLI and begin using it to build high-quality, robust, flexible and maintainable systems using your favourite AI agent.', + }, + items: [ + 'getting-started/installation', + ], + }, + ], +}; diff --git a/documentation/src/components/HomepageFeatures/index.tsx b/documentation/src/components/HomepageFeatures/index.tsx index f0b0c0ed..906a0579 100644 --- a/documentation/src/components/HomepageFeatures/index.tsx +++ b/documentation/src/components/HomepageFeatures/index.tsx @@ -1,26 +1,26 @@ -import React, { JSX } from 'react'; -import Link from '@docusaurus/Link'; -import clsx from 'clsx'; -import styles from './styles.module.css'; +import React, { JSX } from "react"; +import Link from "@docusaurus/Link"; +import clsx from "clsx"; +import styles from "./styles.module.css"; type SectionItem = { - Svg: React.ComponentType>; + Svg: React.ComponentType>; button: { title: string; link: string }; }; const SectionList: SectionItem[] = [ { - Svg: require('@site/static/img/Bitloops-Language-Logo.svg').default, + Svg: require("@site/static/img/Bitloops-Logo.svg").default, // Update the path to your actual SVG button: { - title: 'Bitloops Language', - link: '/docs/bitloops-language/introduction/welcome', - }, + title: "Bitloops CLI", + link: "/docs/cli/getting-started/installation", // Update the link to the starting page of your design-2-code docs }, + }, { - Svg: require('@site/static/img/Bitloops-Logo.svg').default, // Update the path to your actual SVG + Svg: require("@site/static/img/Bitloops-Language-Logo.svg").default, button: { - title: 'Design 2 Code', - link: '/docs/design-2-code/overview/introduction-to-bitloops', // Update the link to the starting page of your design-2-code docs + title: "Bitloops Language", + link: "/docs/bitloops-language/introduction/welcome", }, }, ]; @@ -28,7 +28,7 @@ const SectionList: SectionItem[] = [ function Section({ Svg, button }: SectionItem) { return ( //
-
+
diff --git a/documentation/src/pages/index.tsx b/documentation/src/pages/index.tsx index 8d3ce27a..cda6dc32 100644 --- a/documentation/src/pages/index.tsx +++ b/documentation/src/pages/index.tsx @@ -1,16 +1,16 @@ -import React, { JSX } from 'react'; -import clsx from 'clsx'; +import React, { JSX } from "react"; +import clsx from "clsx"; // import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; +import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; +import Layout from "@theme/Layout"; +import HomepageFeatures from "@site/src/components/HomepageFeatures"; -import styles from './index.module.css'; +import styles from "./index.module.css"; function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); return ( -
+

{siteConfig.title}

{siteConfig.tagline}

@@ -30,8 +30,8 @@ export default function Home(): JSX.Element { const { siteConfig } = useDocusaurusContext(); return (
diff --git a/documentation/yarn.lock b/documentation/yarn.lock index 4bea6905..2085bd86 100644 --- a/documentation/yarn.lock +++ b/documentation/yarn.lock @@ -3099,9 +3099,9 @@ caniuse-api@^3.0.0: lodash.uniq "^4.5.0" caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001646, caniuse-lite@^1.0.30001688: - version "1.0.30001692" - resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001692.tgz" - integrity sha512-A95VKan0kdtrsnMubMKxEKUKImOPSuCpYgxSQBo036P5YYgVIcOYJEgt/txJWqObiRQeISNCfef9nvlQ0vbV7A== + version "1.0.30001774" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001774.tgz" + integrity sha512-DDdwPGz99nmIEv216hKSgLD+D4ikHQHjBC/seF98N9CPqRX4M5mSxT9eTV6oyisnJcuzxtZy4n17yKKQYmYQOA== ccount@^2.0.0: version "2.0.1"