Skip to content

Commit 2d43424

Browse files
authored
Updated CLI usage docs (#288)
1 parent 9e9f498 commit 2d43424

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ window instead of `localhost`.
7676
4. In a terminal, navigate to the repository's root directory and run
7777

7878
```bash
79-
hatch shell
79+
hatch shell
8080
```
8181

8282
This will create a virtual environment, install Python 12 (if not found), and install the package in editable mode.
@@ -98,20 +98,29 @@ server.launch("sensapex", 8081)
9898

9999
# CLI Usage
100100

101-
Ephys Link can be launched from the command line directly. This is useful for computers or servers without graphical
102-
user interfaces.
101+
Ephys Link can be launched from the command line directly without the configuration window. This is useful for computers
102+
or servers without graphical user interfaces.
103+
104+
With the standalone executable downloaded, invoking the executable from the command line:
105+
106+
```bash
107+
ephys_link-vX.X.X-Windows-x86_64.exe -b
108+
```
109+
110+
Use the actual name of the executable you downloaded. The `-b` or `--background` flag will launch the server without the
111+
configuration window and read configuration from CLI arguments.
103112

104113
Run the following commands in a terminal to start the server for the desired manipulator platform without the startup
105-
window:
114+
window (replace `ephys_link.exe` with the actual name of the executable you downloaded):
106115

107-
| Manipulator Platform | Command |
108-
|--------------------------------------|---------------------------------------------|
109-
| Sensapex uMp-4 | `ephys-link.exe -b` |
110-
| Sensapex uMp-3 | `ephys-link.exe -b -t ump3` |
111-
| New Scale | `ephys-link.exe -b -t new_scale` |
112-
| New Scale via Pathfinder HTTP server | `ephys-link.exe -b -t new_scale_pathfinder` |
116+
| Manipulator Platform | Command |
117+
|------------------------------------------|---------------------------------------------|
118+
| Sensapex uMp-4 | `ephys_link.exe -b` |
119+
| Sensapex uMp-3 | `ephys_link.exe -b -t ump3` |
120+
| New Scale Pathfinder MPM Control v2.8.8+ | `ephys_link.exe -b -t new_scale_pathfinder` |
121+
| New Scale M3-USB-3:1-EP | `ephys_link.exe -b -t new_scale` |
113122

114-
More options can be viewed by running `ephys-link.exe -h`.
123+
More options can be viewed by running `ephys_link.exe -h`.
115124

116125
# Documentation and More Information
117126

0 commit comments

Comments
 (0)