Skip to content

Commit d65f542

Browse files
committed
init documentation for ins arch
1 parent dc65cbe commit d65f542

2 files changed

Lines changed: 107 additions & 0 deletions

File tree

‎.vitepress/config.mts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ export default defineConfig({
7070
items: [
7171
{ text: 'Welcome', link: '/docs/' },
7272
{ text: 'Installation Guide', link: '/docs/installguide' },
73+
{ text: 'Arch Installer (ins arch)', link: '/docs/insarch' },
7374
{ text: 'Quick Start', link: '/docs/getting started' },
7475
{ text: 'Update', link: '/docs/update' },
7576
{ text: 'Dotfile management', link: '/docs/insdot' },

‎docs/insarch.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Arch installation with `ins arch`
2+
3+
::: info
4+
There are two installers in circulation right now:
5+
6+
- `ins arch` (Rust, instantCLI): the new installer command
7+
- `instantARCH` (bash): the legacy installer used by older ISOs and the `instantos.io/install` script
8+
9+
Both are documented below so you can match what you see on your system.
10+
:::
11+
12+
## `ins arch` (Rust, instantCLI)
13+
14+
`ins arch` is the Rust-based installer being built into instantCLI. It is meant
15+
to replace the old bash installer and can be used on Arch/instantOS environments
16+
(including the live ISO).
17+
18+
### Quick start
19+
20+
```bash
21+
sudo ins arch install
22+
```
23+
24+
This runs the full flow: asks all questions, writes
25+
`/etc/instant/questions.toml`, executes the install steps, then shows the
26+
finished menu.
27+
28+
### Requirements
29+
30+
- Arch or instantOS environment (installer refuses other distros)
31+
- x86_64 architecture
32+
- Working internet connection
33+
- Root privileges for `install`, `ask` (full questionnaire), and `exec`
34+
35+
### Command reference
36+
37+
#### `ins arch install`
38+
39+
Runs the full wizard: `ask` -> `exec` -> `finished`.
40+
41+
#### `ins arch list`
42+
43+
Lists all available question IDs for `ins arch ask`.
44+
45+
#### `ins arch ask [question-id]`
46+
47+
Interactive questionnaire. Without an ID it asks all questions and writes a
48+
TOML config file.
49+
50+
```bash
51+
ins arch ask
52+
ins arch ask <question-id>
53+
ins arch ask --output-config /tmp/instantos-questions.toml
54+
```
55+
56+
#### `ins arch exec [--step <step-id>]`
57+
58+
Executes installation steps based on a questions file.
59+
60+
```bash
61+
ins arch exec --questions-file /etc/instant/questions.toml
62+
ins arch exec --dry-run
63+
```
64+
65+
#### `ins arch setup`
66+
67+
Set up instantOS on an existing Arch Linux installation (not a live ISO).
68+
69+
```bash
70+
sudo ins arch setup --user alice
71+
sudo ins arch setup --dry-run
72+
```
73+
74+
#### `ins arch info`
75+
76+
Prints detected system information (boot mode, architecture, GPU, etc.). Safe
77+
to run on any distro.
78+
79+
#### `ins arch dualboot info`
80+
81+
Analyzes disks for dual boot feasibility and shows partition details.
82+
83+
#### `ins arch upload-logs`
84+
85+
Uploads `/var/log/instantos/install.log` to snips.sh for troubleshooting.
86+
87+
#### `ins arch finished`
88+
89+
Shows the post-install menu (reboot, shutdown, or continue in live session).
90+
91+
### Files and logs
92+
93+
- `/etc/instant/questions.toml` stores the generated installation answers
94+
- `/var/log/instantos/install.log` captures the installer logs
95+
96+
## Legacy: `instantARCH` (bash)
97+
98+
`instantARCH` is the older bash-based installer built around `instantmenu`. It
99+
is still what the `instantos.io/install` script runs and what older instantOS
100+
ISOs ship with.
101+
102+
- Run from an Arch live ISO with `bash <(curl -L instantos.io/install)`
103+
- Debug mode: set `INSTALLDEBUG=1` or create `/tmp/installdebug`
104+
- Optional log tag: put an identifier in `/tmp/debugname`
105+
106+
For deeper development notes, see [instantARCH development docs](/development/instantARCH).

0 commit comments

Comments
 (0)