Skip to content

Commit

Permalink
📝 Adjust config in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
segersniels committed Jan 3, 2020
1 parent b1d2aec commit 921eefc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,16 +85,16 @@ As of version `2.2.0` I introduced the option to fuzzy search by name for certai

In the normal `supdock` behaviour I originally intended commands like `supdock logs -f` to show a prompt with available options when no id or container name was passed. So when a user passed `supdock logs -f foobar` it would break the custom functionality and passthrough straight to `docker`. This made sure `supdock` wasn't too much of a drastic change to the default docker behaviour.

So coming back to the new fuzzy search. With fuzzy searching enabled you can now search based on a part of the container name like the following: `docker logs -f foo`. Which then matches your search term `foo` with the container named `foobar`. In the versions pre `2.2.0` of `supdock` it would just passthrough to docker and tell you the `foo` container didn't exist. This behaviour is disabled by default and can be enabled by doing the following: `supdock enable allow-fuzzy-search`. And can ofcourse be disabled by using `supdock disable allow-fuzzy-search`.
So coming back to the new fuzzy search. With fuzzy searching enabled you can now search based on a part of the container name like the following: `docker logs -f foo`. Which then matches your search term `foo` with the container named `foobar`. In the versions pre `2.2.0` of `supdock` it would just passthrough to docker and tell you the `foo` container didn't exist. This behaviour is disabled by default and can be enabled by doing the following: `supdock enable fuzzy-search`. And can ofcourse be disabled by using `supdock disable fuzzy-search`.

```
Usage: supdock enable [OPTIONS]
Enable certain supdock functionality
Options:
ask-for-confirmation (When fuzzy searching is enabled we ask the user for confirmation before we execute the command. Default: enabled)
allow-fuzzy-search (Disable fuzzy searching. Default: disabled)
caution-check (When fuzzy searching is enabled we ask the user for confirmation before we execute the command. Default: enabled)
fuzzy-search (Disable fuzzy searching. Default: disabled)
```

The config file is created at `${HOME}/.supdock/config.json`.
Expand Down

0 comments on commit 921eefc

Please sign in to comment.