labt 0.2.12

Lab-t Lightweight Android build tool
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

[![Labt Logo](assets/logo_400x200.png)](https://gitlab.com/lab-tool/labt)
[![Crates.io Version](https://img.shields.io/crates/v/labt?logo=rust)](https://crates.io/crates/labt)
![GitLab License](https://img.shields.io/gitlab/license/lab-tool%2Flabt)
# Lightweight Android Build tool (LABt)
**LABt** is a command line interface tool written in Rust for building your android projects
on the terminal. It provides dependency management tools to easily add and 
resolve your project dependencies. It aims to work fully offline and only
requiring network during resolution when the dependencies were not cached
locally.

At its core, labt provides a plugin system to build applications. The plugins
system provides lua scripting for easy to implement and lightweight plugins.

_NB: This project is a working progress and currently very unstable_

## Installation
Install using cargo

```bash
cargo install labt
```

### Os support
Currently the base support is on *Linux* based OS

future cross platform support is planned

## Usage
Initialize a new a new android project

```bash
labt init
```
This creates a new project. 


Add a dependency to your project

```bash 
labt add androidx.appcompat:appcompat:1.1.0
```
the add subcommand automatically downloads and caches the provided dependency.
You can also fetch the dependencies manually by running.

```bash
labt resolve
```

Labt on its own just manages your projects and its dependencies. To do a build of your app, 
you will need a plugin. Choose a plugin of your choice from any git compatible repository
and `use` it for your build proccess. For example, use [labt-java](https://gitlab.com/lab-tool/plugins/labt-java)
to build a java application.

```
labt plugin use labt-java v0.1.0 https://gitlab.com/lab-tool/plugins/labt-java
```

Now you can run `labt build` and the plugin will build the application for you. If you have special 
requirements to build your application check the [LABt Lua API documentation](doc/LuaAPI.md) on how to
create a custom plugin.

for more information you could try `labt help`

```bash
Usage: labt [COMMAND]

Commands:
  add      Adds a new project dependency
  init     Initializes a new project
  resolve  Fetches the project dependencies
  build    Builds the project
  plugin   Manage plugins
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

```

## Plugin system
Labt on its own cant really do much. It provides tools to manage projects and their
dependencies. To extend the capability of labt, it provides a powerful Lua scripting
plugin system. This allows custom plugins to do the heavy lifting of building applications.
For more information on plugin system check the [LABt Lua API documentation](doc/LuaAPI.md).

## TODO
- [ ] Add a FFI capability for plugins
- [ ] Support for windows file system
- [ ] Add a configurable template system
- [ ] Stabilize the plugin api and interpret versions of plugins
- [ ] Shorten the plugin use command