README.md

Teex

Use Elixir like a scripting language, across your system

HEY THERE! This is a very hacky and experimental tool that solves a weird problem. I really wanted to be able to use Elixir like python all over my system environment. But in order to use any of the Hex packages, I needed a proper Mix project. Teex negates that by shimming into your IEx sessions, and injecting the code paths of libraries you install inside your workspaces.

This has no tests yet. This is basically in-dev. Here be dragons!

Contributions appreciated :D

FYI: This was renamed from "Tex" to avoid confusion with TeX -- This project is now called Teex! The GIFs below might still mention tex -- just replace that in your commands with teex

How To Use

Install

Install the escript using mix: mix escript.install hex teex

IMPORTANT: Ensure you add your escript directory to your PATH otherwise you won't be able to use the teex command from anywhere!

(If you're using asdf-vm it may be something like "/home/USER/.asdf/installs/elixir/VERSION/.mix/escripts/", you'll probably want to set your global elixir properly before installing teex)

Run the teex init command

Do what it says! Paste the line it generates between the lightbulbs into your ~/.iex.exs file!

It should look something like: c "/path/to/your/home/.teex.exs"

Create A Workspace

Install A Hex Library

Load Your Workspace!

You can load any workspace using Teex.workspace/1 with a string of your workspace name. It will load up the code paths for all your installed libraries in that workspace!

Advanced Script Usage!

You can even use Elixir and Teex together to create useful scripts that are usable anywhere on your system.

Here's an example script that loads a workspace, uses Jason, and prints the string to STDOUT

#! iex

## ^ include the above so you can simply do:
## ./my_script.exs

## Load your teex shim file
Code.require_file "/home/aaron/.teex.exs"

## Pick your teex workspace
## Let's assume this workspace has Jason installed in it
Teex.workspace "test"

## Do some stuff!
## Let's encode a map to JSON and output it to STDOUT

## Encode using Jason
obj_string = Jason.encode!(%{
    "a" => 1,
    "b" => false,
    "c" => %{
      "nested" => "map"
    }
})

# Write to stdout!
IO.puts(obj_string)

# Exit :)
exit(0)

You can use the above script simply by running:

chmod +x my_script.exs
./my_script.exs > output.json

Command List

teex init - Creates the initial .teex.exs shim file to be used in IEx sessions.

teex workspace create my_workspace - Creates a workspace

teex workspace destroy my_workspace - Destroy a workspace (this can't be undone!)

teex install [hex_lib_name] 1.0.0 --workspace my_workspace - Install a Hex.pm library by name into a workspace at the specified version

teex uninstall [hex_lib_name] --workspace my_workspace - Remove a Hex.pm library by name from a workspace