letstry

letstry is a powerful tool designed to provide temporary work-spaces for developers, built in Golang. It allows you to quickly create new projects, save them as templates, and export them to a more permanent location.

Index

• Installation
• Usage
  • Create a new session
  • Export a session
  • List active sessions
  • Managing Templates
  • Configuration
• Contributing
• Development

Installation

Letstry requires Go to be installed on your system. If you do not have Go installed, you can download it from the official website.

Once Go is installed, to install letstry, run the following command:

go install github.com/letstrygo/letstry@latest

Optional: Configure lt alias

letstry is easier to use when you configure the lt alias. This allows you to type lt instead of typing out the full letstry command when you use it.

Windows Powershell

Assuming you already have $profile configured

"`nset-alias lt letstry" | out-file -append -encoding utf8 $profile; . $profile

Bash

echo "alias lt='letstry'" >> ~/.bashrc && source ~/.bashrc

Usage

Creating a new Session

Creating a new session with letstry is simple and efficient. Use the lt new command to initialize a temporary project directory and open it in the default editor. This allows for quick prototyping. If you like the results, you can export the session to a more permanent location or save it as a template.

$ lt new

If the VSCode window is closed, the temporary directory will be deleted. Therefore, you should either export your project using lt export <path> or save it as a template using lt save <template-name>.

Lets try sessions can be created from a directory path, a git repository URL, or a template name.

$ lt new <repository-url>
$ lt new <directory-path>
$ lt new <template-name>

Exporting a Session

To export a session, use the lt export command from within the sessions directory. This will copy the session to the directory you specify.

$ lt export <path>

Listing active sessions

To list all active sessions, use the lt list command.

$ lt list

Managing Templates

Creating a template

Templates are a powerful feature of letstry. They allow you to save a project as a template and quickly create new projects based on that template.

To save an active session as a template, use the lt save command from within the sessions directory.

$ lt save [template-name]

If the session was initially created from an existing template, you can omit the name argument and the original template will be updated with the new session.

Importing a Template

You can easily import git repositories as templates using the lt import command.

$ lt import <template-name> <repository-url>

Updating Templates

If you've imported a template from a git repository using lt import, or if the template is stored as a git repository (i.e. contains a .git directory), you can use the lt update command to update the template with the latest version from it's associated git repository.

$ lt update <template-name>

Listing Templates

To list all available templates, use the lt templates command.

$ lt templates

Deleting a Template

To delete a template, use the lt delete command.

$ lt delete <template-name>

Configuration

letstry can be configured using a configuration file. The configuration file is located at ~/.letstry/config.json.

The config file allows you to specify different editors if you do not use VSCode.

Windows Config Example

~/.letstry/config.json

{
    "default_editor": "vscode",
    "editors": [
        {
            "name": "vscode",
            "run_type": "run",
            "path": "C:\\Users\\natef\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe",
            "args": "-n",
            "process_capture_delay": 2000000000,
            "tracking_type": "file_access"
        }
    ]
}

Contributing

We welcome contributions to improve letstry. If you have suggestions or bug reports, please open an issue or submit a pull request.

Development

To install letstry for development, run the following command from the root of the project:

$ go install ./

Attaching a Debugger in VSCode

Open the "Run and Debug" tab in VSCode (Ctrl+Shift+D on Windows) and select the Run Letstry configuration.

License

This project is licensed under the MIT License.