Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cilki committed May 5, 2024
1 parent 965b5f2 commit 219e2da
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,50 @@
# Cilki's Git WorkSpace Manager
# WorkSpace eXplorer

`wsm` is a command line utility for quickly cloning (and decloning) Git repositories.
`wsx` is a command line utility for quickly cloning (and decloning) Git repositories
into a local directory called a _workspace_.

### Workspaces

Simply defined, a _working set_ is the set of all repositories you're able to work
on at any given time. Even more simply, your _workspace_ is just the local directory
where you keep your Git repositories.

The principle behind `wsm` is that your Git workspace should only consist of your
The principle behind `wsx` is that your Git workspace should only consist of your
_working set_. This reduces unnecessary noise as repositories accumulate in your
workspace over time and improves indexing performance of your development tools.
Adhering to this principle involves frequently cloning and deleting repositories
from your workspace, which is exactly what `wsm` is designed to automate.
from your workspace, which is exactly what `wsx` is designed to automate.

When repositories are dropped from your workspace, they are cached locally so
restoring them later can be done in an instant.

### Basic Usage
### Keep your working set clean

```sh
# Add or refresh a repository in the default workspace
wsm github.com/cilki/wsm
# Clone a repository into the default workspace
wsx clone github.com/cilki/wsx

# The repository's local path always reflects the remote path for identifiability
cd ~/workspace/github.com/cilki/wsm
cd ~/workspace/github.com/cilki/wsx

# Remove everything I'm not currently working on from the workspace (any repo
# that has no unstaged or unpushed changes).
wsm drop
wsx drop

# Or, you can also select repositories to drop
wsm drop github.com/cilki/*
# Or, you can also use prefix patterns to select repositories to drop
wsx drop github.com/cilki

# If you need to work on a repository again, it's restored from cache which is
# If there were unstaged changes above, you'll have to force it
wsx drop github.com/cilki --force

# When you need to work on a repository again, it's restored from cache which is
# super fast!
wsm github.com/cilki/wsm
wsx clone github.com/cilki/wsx
```

### Basic Configuration
### Simple configuration

`wsm` attempts to read a configuration file from `~/.wsm/config.toml`. For example:
`wsx` attempts to read a configuration file from `~/.config/wsx.toml`. For example:

```toml
# Define any number of workspaces
Expand Down

0 comments on commit 219e2da

Please sign in to comment.