11# WorkSpace eXplorer
22
3- ` wsx ` is a command line utility for quickly cloning (and decloning) Git repositories
4- into a local directory called a _ workspace_ .
3+ ` wsx ` is a command line utility for quickly cloning (and decloning) Git
4+ repositories into a local directory called a _ workspace_ .
55
66### Workspaces
77
8- Simply defined, a _ working set_ is the set of all repositories you're able to work
9- on at any given time. Even more simply, your _ workspace_ is just the local directory
10- where you keep your Git repositories.
8+ Simply defined, a _ working set_ is the set of all repositories you're able to
9+ work on at any given time. Even more simply, your _ workspace_ is just the local
10+ directory where you keep your Git repositories.
1111
12- The principle behind ` wsx ` is that your Git workspace should only consist of your
13- _ working set_ . This reduces unnecessary noise as repositories accumulate in your
14- workspace over time and improves indexing performance of your development tools.
15- Adhering to this principle involves frequently cloning and deleting repositories
16- from your workspace, which is exactly what ` wsx ` is designed to automate.
12+ The principle behind ` wsx ` is that your Git workspace should only consist of
13+ your _ working set_ . This reduces unnecessary noise as repositories accumulate in
14+ your workspace over time and improves indexing performance of your development
15+ tools. Adhering to this principle involves frequently cloning and deleting
16+ repositories from your workspace, which is exactly what ` wsx ` is designed to
17+ automate.
1718
1819When repositories are dropped from your workspace, they are cached locally so
1920restoring them later can be done in an instant.
2021
2122### Keep your working set clean
2223
2324``` sh
24- # Clone a repository into the default workspace
25+ # Initialize a workspace in your current directory
26+ wsx init
27+
28+ # Clone a repository
2529wsx clone github.com/cilki/wsx
2630
2731# The repository's local path always reflects the remote path for identifiability
@@ -42,18 +46,17 @@ wsx drop github.com/cilki --force
4246wsx clone github.com/cilki/wsx
4347```
4448
45- ### Simple configuration
49+ ### TUI Mode
4650
47- ` wsx ` attempts to read a configuration file from ` ~/.config/wsx.toml ` . For example:
51+ Run ` wsx ` without arguments to launch an interactive TUI that lets you browse
52+ and select repositories from your configured remotes:
4853
49- ``` toml
50- # Define any number of workspaces
51- [[workspace ]]
52- name = " personal"
53- path = " /home/user/workspace"
54+ ``` sh
55+ # Launch interactive repository browser
56+ wsx
5457
55- [[workspace ]]
56- name = " work"
57- path = " /home/worker/workspace"
58+ # Use j/k or arrow keys to navigate
59+ # Press / to search/filter repositories
60+ # Press Enter to clone the selected repository
61+ # Press q to quit
5862```
59-
0 commit comments