Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions documentation/docs/cli/getting-started.md
Original file line number Diff line number Diff line change
@@ -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
```
73 changes: 73 additions & 0 deletions documentation/docs/cli/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -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
```
22 changes: 11 additions & 11 deletions documentation/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion documentation/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
15 changes: 15 additions & 0 deletions documentation/sidebarsCli.js
Original file line number Diff line number Diff line change
@@ -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',
],
},
],
};
26 changes: 13 additions & 13 deletions documentation/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
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<React.ComponentProps<'svg'>>;
Svg: React.ComponentType<React.ComponentProps<"svg">>;
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",
},
},
];

function Section({ Svg, button }: SectionItem) {
return (
// <div className={clsx('col col--4')}>
<div className={clsx('col')}>
<div className={clsx("col")}>
<div className={styles.section}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
Expand Down
18 changes: 9 additions & 9 deletions documentation/src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -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 (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<header className={clsx("hero hero--primary", styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
Expand All @@ -30,8 +30,8 @@ export default function Home(): JSX.Element {
const { siteConfig } = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />"
title={`Bitloops Documentation`}
description="Bitloops Documentation about the Bitloops CLI"
>
<HomepageHeader />
<main>
Expand Down
6 changes: 3 additions & 3 deletions documentation/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down