4 releases (2 breaking)

new 0.3.4 Nov 28, 2024
0.2.12 Mar 26, 2024
0.2.8 Mar 20, 2024
0.1.0 Mar 17, 2024

#106 in Build Utils

Download history 17/week @ 2024-09-23 145/week @ 2024-11-25

145 downloads per month

Custom license

775KB
14K SLoC

Labt Logo Crates.io Version GitLab License GitLab pipeline

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

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

labt init

This creates a new project.

Add a dependency to your project

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.

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 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 on how to create a custom plugin.

for more information you could try labt help

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
  sdk      Sdk manager
  help     Print this message or the help of the given subcommand(s)

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

Here's a more concise version:

SDK Manager

LABt's SDK Manager lets you manage Android SDK packages via a terminal interface.

  • Interactive Management: Use labt sdk list to view and toggle package actions (install, uninstall, upgrade/downgrade) in a TUI.

  • Installing: labt sdk install <id> to install a package non interactively.

  • Lua API Integration: Plugins can access SDK packages directly through LABt's Lua API. More details here.

    local build = require("sdk:build")
    local ok, stdout, stderr = build.get_aapt2("version")
    local version
    
    if ok then
        version = stderr  -- Note: `aapt2` outputs to `stderr`
    else
        error(stderr)
    end
    

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.

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
  • Sdkmanager support multiple repositories

Dependencies

~28–42MB
~729K SLoC