Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pitkley/i3nator
i3nator is Tmuxinator for the i3 window manager
https://github.com/pitkley/i3nator
cli i3 i3wm rust
Last synced: 8 days ago
JSON representation
i3nator is Tmuxinator for the i3 window manager
- Host: GitHub
- URL: https://github.com/pitkley/i3nator
- Owner: pitkley
- License: apache-2.0
- Created: 2017-05-31T17:15:09.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T04:57:43.000Z (over 1 year ago)
- Last Synced: 2024-10-31T11:45:18.828Z (20 days ago)
- Topics: cli, i3, i3wm, rust
- Language: Rust
- Size: 4.44 MB
- Stars: 63
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# i3nator
i3nator is [Tmuxinator][gh-tmuxinator] for the [i3 window manager][i3wm].
It allows you to manage what are called "projects", which are used to easily restore saved i3
layouts (see [Layout saving in i3][i3wm-layout-saving]) and extending i3's base functionality
by allowing you to automatically start applications too.
* [Documentation][i3nator-docs]
* [GitHub source repository][i3nator-gh]
* [Example configurations][i3nator-examples]
## Installation
You have multiple options to install i3nator:
1. If you have a recent Rust with Cargo installed, you can install `i3nator` directly from
crates.io:
```console
$ cargo install i3nator
```
2. Alternatively, you can download the supplied static binary from the [release
page][i3nator-releases], this should work without any additional dependencies.
3. Another option is to install from directly from source (this again requires a recent Rust
installation):
```console
$ git clone https://github.com/pitkley/i3nator.git
$ cd i3nator
$ cargo install
```
**Note:** If you want to be able to use the automatic command execution feature, you will need
to install [`xdotool`][xdotool].
## Usage
```text
i3nator 1.2.0
Pit Kleyersburg
i3nator is Tmuxinator for the i3 window manager
USAGE:
i3nator
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
copy Copy an existing project to a new project
delete Delete existing projects
edit Open an existing project in your editor
help Prints this message or the help of the given subcommand(s)
info Show information for the specified project
layout Manage layouts which can used in projects
list List all projects
local Run a project from a local TOML-file
new Create a new project and open it in your editor
rename Rename a project
start Start a project according to it's configuration
verify Verify the configuration of the existing projects
```
Every command -- except `layout` -- is for managing your projects, i.e. creating, editing,
starting and potentially deleting them.
`layout` is a bit special, because it is most of the commands used for projects, except for i3
layouts:
```text
i3nator-layout 1.2.0
Manage layouts which can used in projects
USAGE:
i3nator layout
FLAGS:
-h, --help Prints help information
SUBCOMMANDS:
copy Copy an existing layout to a new layout
delete Delete existing layouts
edit Open an existing layout in your editor
help Prints this message or the help of the given subcommand(s)
info Show information for the specified layout
list List all layouts
new Create a new layout and open it in your editor
rename Rename a layout
```
These commands allow you to manage [i3 layouts][i3wm-layout-saving] in addition to the actual
projects which will be able to use and reuse them.
## Examples
(See [here][i3nator-examples] for additional examples. See also the [`types::Config` API
documentation][i3nator-docs-types-Config] for detailed documentation on the configuration
parameters.)
### Full workflow
1. Open all applications you want and lay them out on a workspace as desired.
2. Save the workspace's layout using [`i3-save-tree`][i3wm-save-tree], feeding the layout
directly into i3nator's layout management:
```console
$ i3-save-tree --workspace 1 | i3nator layout new -t - mylayout
```
If you don't want the layout managed by i3nator, you can alternatively:
* copy the layout to your clipboard, and insert it directly in your project configuration
later *or*
* save it to a file on your disk, and reference this file-path in your configuration later.
If you are using i3nator's layout management, the above command should drop you into an
editor, ready for step 3.
3. Modify the saved layout to accurately match created applications. See [Editing layout
files][i3wm-modify-layout] on how to do this.
If you copied the layout to your clipboard, you will be able to do this in step 5.
4. Create a new project:
```console
$ i3nator new myproject
Created project 'myproject'
Opening your editor to edit 'myproject'
```
This will open your default editor with a configuration template. If it doesn't, you have to
specify either the `$VISUAL` or the `$EDITOR` environment variable.
You can also simply edit the configuration file directly. Use `i3nator info ` to
retreive its path.
5. Modify the template to fit your needs. This includes:
1. Setting the main working directory.
2. Setting the destination workspace (this is optional, if not specified, the active one
will be used).
3. Specifying which layout to use. If you have passed the layout to i3nator in step 2, you
can simply enter its name here, which in case two was `mylayout`.
Alternatively you can either supply a path to the file containing the layout, or you can
paste the layout from step 2 directly into your project file as a multi-line string. At
this point you will also be able to modify the layout to match applications correctly.
4. Configuring which applications to start and how to start them. This is done by setting
the `command` to the full command to be used to start the application and optionally
configuring a different working directory if desired.
If you want to execute additional commands or keypresses in the started applications,
you can also define `exec`.
The resulting configuration could look something like this:
```toml
[general]
working_directory = "/path/to/my/working/directory"
workspace = "1"
layout = "mylayout"
[[applications]]
command = "mycommand --with 'multiple args'"
exec = ["command one", "command two"]
```
6. Save and close your editor. This will automatically verify the created configuration. If
there is an issue it will tell you what failed and allow you to reedit the file directly or
ignore the error and exit.
With these prerequisites fulfilled, you are now able to start a configuration which appends
your layout to a specified workspace and starts the configured applications:
```console
$ i3nator start myproject
```
In general, the versioning scheme follows the semantic versioning guidelines:
* The patch version is bumped when backwards compatible fixes are made (this includes updates to dependencies).
* The minor version is bumped when new features are introduced, but backwards compatibility is retained.
* The major version is bumped when a backwards incompatible change was made.
Special case:
* A bump in the minimum supported Rust version (MSRV), which is currently 1.54.0, will be done in patch version updates (i.e. they do not require a major or minor version bump).
## License
i3nator is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
#### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in i3nator by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
[gh-tmuxinator]: https://github.com/tmuxinator/tmuxinator
[i3nator-docs]: https://docs.rs/i3nator
[i3nator-docs-types-Config]: https://docs.rs/i3nator/*/i3nator/types/struct.Config.html
[i3nator-examples]: https://github.com/pitkley/i3nator/tree/main/examples
[i3nator-gh]: https://github.com/pitkley/i3nator
[i3nator-releases]: https://github.com/pitkley/i3nator/releases
[i3wm]: https://i3wm.org/
[i3wm-modify-layout]: https://i3wm.org/docs/layout-saving.html#_editing_layout_files
[i3wm-layout-saving]: https://i3wm.org/docs/layout-saving.html
[i3wm-save-tree]: https://i3wm.org/docs/layout-saving.html#_saving_the_layout
[xdotool]: https://github.com/jordansissel/xdotool