luxctl 0.8.2

Learn by building - CLI for projectlighthouse.io
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

# luxctl

CLI for [projectlighthouse.io](https://projectlighthouse.io) — learn by building real systems.

![luxctl](./images/luxctl-dev-env.png)

## Install

### Pre-built Binaries (Recommended)

Download the latest binary for your platform from the [releases page](https://github.com/thearyanahmed/luxctl/releases):


### Via Install Script

```bash
# one-liner (installs Rust if needed)
curl -fsSL https://raw.githubusercontent.com/thearyanahmed/luxctl/master/install.sh | bash
```

### Via Cargo

```bash
# latest version
cargo install luxctl

# specific version
cargo install luxctl --version 0.7.0
```

## Quick Start

```bash
# authenticate with your token from projectlighthouse.io
luxctl auth --token $token

# verify setup
luxctl doctor

# see who you are
luxctl whoami
```

## Usage

```bash
# list available projects
luxctl project list

# start a project
luxctl project start --slug tcp-echo-server --runtime go

# list tasks for current project
luxctl task list

# show task details
luxctl task show --task 1

# run validation
luxctl run --task 1

# run with verbose per-expectation output
luxctl run --task 1 --detailed

# validate all tasks
luxctl validate

# validate all with verbose output
luxctl validate --detailed

# get hints (costs points)
luxctl hint list --task 1
luxctl hint unlock --task 1 --hint $hint_uuid
```

## Development

```bash
cargo build           # debug build
cargo test            # run tests
cargo fmt             # format
cargo clippy          # lint
```

## Supported Runtimes

- **Go** - detects `go.mod`, builds with `go build .`
- **Rust** - detects `Cargo.toml`, builds with `cargo check`

## Contributing

Contributions are welcome! Here's how to get started:

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/my-feature`
3. Make your changes
4. Run checks: `cargo fmt && cargo clippy && cargo test`
5. Commit with a clear message
6. Push and open a pull request

### Guidelines

- Follow existing code style
- Add tests for new functionality
- Keep commits focused and atomic
- Update documentation as needed

### Reporting Issues

- Check existing issues before creating a new one
- Include luxctl version (`luxctl --version`)
- Include OS and architecture
- Provide steps to reproduce

## Release

Releases are automated via GitHub Actions. To create a new release:

1. Update version in both `Cargo.toml` and `src/lib.rs`
2. Run `cargo build` to update `Cargo.lock`
3. Commit and push to master
4. Wait for Auto Tag workflow to create the version tag
5. Trigger the Release workflow:
   ```bash
   gh workflow run Release --field tag=v0.6.2
   ```

The Release workflow will:
- Run tests
- Verify version matches tag
- Publish to crates.io
- Generate changelog
- Create GitHub release

## License

AGPL-3.0 - See [LICENSE](LICENSE) for details.

This means you can use, modify, and distribute this software, but if you modify it and provide it as a service (even over a network), you must release your source code under the same license.