Skip to content

Commit 850b498

Browse files
authored
improve readme
fixes #31
1 parent b1cb968 commit 850b498

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
11
# Geode Command Line
2-
Command-line utilities for working w/ geode.
2+
Command-line utilities for working with [Geode SDK](https://geode-sdk.org).
3+
4+
For more information see its [page on the docs](https://docs.geode-sdk.org/getting-started/geode-cli).
5+
6+
## Usage
7+
The CLI is typically invoked for you by Geode's build system, but it does have some standalone features:
8+
9+
``` bash
10+
# Walks you through creating a Geode mod via a template
11+
geode new
12+
13+
# Runs Geometry Dash from the default profile
14+
geode run
15+
16+
# Installs the sdk. For more info see the docs
17+
geode sdk install
18+
19+
# Uploads a mod to the index. For more info see the docs
20+
geode index mods create
21+
```
22+
23+
## Installation
24+
*(For more in depth information see the docs.)*
25+
26+
### Windows (scoop)
27+
```
28+
scoop bucket add extras
29+
scoop install geode-sdk-cli
30+
```
31+
32+
### Windows (Winget)
33+
> This may be out of date. Sorry!
34+
```
35+
winget install GeodeSDK.GeodeCLI
36+
```
37+
38+
### MacOS (brew)
39+
```
40+
brew install geode-sdk/geode/geode-cli
41+
```
42+
43+
### Linux
44+
We provide linux binaries [in every release](https://github.com/geode-sdk/cli/releases/latest).
45+
46+
### Arch Linux (Unoffical AUR package)
47+
> **Note**: This package is unofficial and not maintained by us. Use at your own risk.
48+
49+
[geode-cli-bin](https://aur.archlinux.org/packages/geode-cli-bin)
50+
51+
### From source
52+
> **Note**: This require a [local rust installation](https://www.rust-lang.org/tools/install), and can take a very long time
53+
```
54+
cargo install --git https://github.com/geode-sdk/cli
55+
```

0 commit comments

Comments
 (0)