Skip to content

Commit a400994

Browse files
signorecellosignorecello
committed
initial
1 parent 751d96a commit a400994

File tree

7 files changed

+62
-89
lines changed

7 files changed

+62
-89
lines changed

‎README.md‎

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,58 +6,12 @@ This repository contains [Dev Container Features](https://containers.dev/impleme
66

77
This repository provides the following features:
88

9-
### 1. Nargo CLI (`nargo`)
10-
11-
Installs the Noir language compiler and toolchain.
12-
13-
- **ID**: `nargo`
14-
- **Description**: Installs the Nargo CLI tool and its installer `noirup`
15-
- **Options**:
16-
- `version`: The version of Nargo to install (default: `latest`, can be set to `nightly` or a specific version)
17-
18-
### 2. Barretenberg (`bb`)
19-
20-
Installs the Barretenberg prover backend for Noir.
21-
22-
- **ID**: `bb`
23-
- **Description**: Installs the Barretenberg CLI tool and its installer `bbup`
24-
- **Options**:
25-
- `version`: The version of Barretenberg to install (default: `nargo`, meaning it will match with an existing Nargo installation)
9+
- Nargo CLI and Noirup
10+
- BB CLI and BBup
2611

2712
## Usage
2813

29-
Add these features to your `devcontainer.json` file:
30-
31-
```json
32-
"features": {
33-
"ghcr.io/yourusername/feature-starter/nargo:1.0.0": {},
34-
"ghcr.io/yourusername/feature-starter/bb:1.0.0": {}
35-
}
36-
```
37-
38-
### Examples
39-
40-
Install the latest stable Nargo and Barretenberg:
41-
42-
```json
43-
"features": {
44-
"ghcr.io/signorecello/feature-starter/nargo:1.0.0": {},
45-
"ghcr.io/signorecello/feature-starter/bb:1.0.0": {}
46-
}
47-
```
48-
49-
Install the nightly version of Nargo and a specific version of Barretenberg:
50-
51-
```json
52-
"features": {
53-
"ghcr.io/signorecello/feature-starter/nargo:1.0.0": {
54-
"version": "nightly"
55-
},
56-
"ghcr.io/signorecello/feature-starter/bb:1.0.0": {
57-
"version": "0.80.0"
58-
}
59-
}
60-
```
14+
Check the READMEs in `src/barretenberg` and `src/noir` for usage instructions
6115

6216
## Development
6317

@@ -70,7 +24,4 @@ You can test the features using the Dev Container CLI:
7024
```bash
7125
devcontainer features test --global-scenarios-only .
7226
```
73-
74-
## License
75-
76-
This project is available under the MIT license.
27+

‎src/barretenberg/README.md‎

100755100644
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11

2-
# Barretenberg
2+
# Barretenberg (barretenberg)
33

4-
A feature that installs the Barretenberg `cli` tool `bb` and its installer `bbup`.
4+
A feature to install Barretenberg
55

66
## Example Usage
77

8-
You can specify any version of `bb`, or leave empty to match with an existent version of `nargo` on the container.
9-
108
```json
119
"features": {
12-
"ghcr.io/devcontainers/feature/barretenberg:1": {
13-
"version": "0.80.0"
14-
}
10+
"ghcr.io/signorecello/noir-bb-devcontainer-feature/barretenberg:1": {}
1511
}
1612
```
1713

1814
## Options
1915

20-
| Options Id | Description | Type | Default Value |
21-
| ---------- | ---------------------- | ------ | ------------- |
22-
| version | The version to install | string | nargo |
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | The version of Barretenberg to install. Defaults to the latest Nargo compatible version. | string | nargo |
19+
20+
21+
22+
---
23+
24+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/signorecello/noir-bb-devcontainer-feature/blob/main/src/barretenberg/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

‎src/barretenberg/devcontainer-feature.json‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
{
22
"name": "Barretenberg",
3-
"id": "bb",
4-
"version": "1.0.0",
3+
"id": "barretenberg",
4+
"version": "1.1.2",
55
"description": "A feature to install Barretenberg",
66
"options": {
77
"version": {
88
"type": "string",
9-
"default": "nargo",
9+
"default": "",
1010
"description": "The version of Barretenberg to install. Defaults to the latest Nargo compatible version."
1111
}
1212
},
13-
"installsAfter": ["./noir"]
13+
"dependsOn": {
14+
"ghcr.io/signorecello/noir-bb-devcontainer-feature/noir:1": {}
15+
}
1416
}

‎src/barretenberg/install.sh‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ fi
1010

1111
apt update && apt install -y curl bash git tar gzip libc++-dev unzip jq
1212

13-
echo "curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash" >> /etc/profile.d/noir.sh
14-
echo "\$HOME/.bb/bbup ${VERSION}" >> /etc/profile.d/noir.sh
15-
echo "PATH=\$HOME/.bb/bin:$PATH" >> /etc/profile.d/noir.sh
13+
cat >> /etc/profile.d/noir.sh << EOF
14+
15+
curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash
16+
17+
PATH=\$HOME/.bb/bin:\$PATH
18+
bash \$HOME/.bb/bbup ${VERSION}
19+
20+
EOF
21+
22+
chmod +x /etc/profile.d/noir.sh
23+
chmod 755 /etc/profile.d/noir.sh

‎src/noir/README.md‎

100755100644
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11

2-
# Nargo
2+
# Noir (noir)
33

4-
A feature that installs the Nargo `cli` tool `nargo` and its installer `noirup`.
4+
A feature to install Noir
55

66
## Example Usage
77

8-
You can specify any version of `noir`, or leave empty to install the latest stable. Pass `nightly` for the latest nightly version.
9-
108
```json
119
"features": {
12-
"ghcr.io/devcontainers/feature/barretenberg:1": {
13-
"version": "nightly"
14-
}
10+
"ghcr.io/signorecello/noir-bb-devcontainer-feature/noir:1": {}
1511
}
1612
```
1713

1814
## Options
1915

20-
| Options Id | Description | Type | Default Value |
21-
| ---------- | ---------------------- | ------ | ------------- |
22-
| version | The version to install | string | nargo |
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | The version of Noir to install | string | latest |
19+
20+
21+
22+
---
23+
24+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/signorecello/noir-bb-devcontainer-feature/blob/main/src/noir/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

‎src/noir/devcontainer-feature.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"name": "Nargo",
3-
"id": "nargo",
4-
"version": "1.0.0",
5-
"description": "A feature to install Nargo",
2+
"name": "Noir",
3+
"id": "noir",
4+
"version": "1.1.2",
5+
"description": "A feature to install Noir",
66
"options": {
77
"version": {
88
"type": "string",
9-
"default": "latest",
10-
"description": "The version of Nargo to install"
9+
"default": "",
10+
"description": "The version of Noir to install"
1111
}
1212
}
1313
}

‎src/noir/install.sh‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ fi
1212

1313
apt update && apt install -y curl bash git tar gzip libc++-dev unzip jq
1414

15-
echo "curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash" >> /etc/profile.d/noir.sh
16-
echo "\$HOME/.nargo/bin/noirup ${VERSION}" >> /etc/profile.d/noir.sh
17-
echo "PATH=\$HOME/.nargo/bin:$PATH" >> /etc/profile.d/noir.sh
15+
cat >> /etc/profile.d/noir.sh << EOF
16+
17+
curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash
18+
19+
PATH=\$HOME/.nargo/bin:\$PATH
20+
bash \$HOME/.nargo/bin/noirup ${VERSION}
21+
22+
EOF
23+
24+
chmod +x /etc/profile.d/noir.sh
25+
chmod 775 /etc/profile.d/noir.sh

0 commit comments

Comments
 (0)