Skip to content

Commit

Permalink
doc for cli 1Remote/1Remote#427
Browse files Browse the repository at this point in the history
  • Loading branch information
VShawn committed Jul 2, 2023
1 parent 8a3fec2 commit 19470e1
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 3 deletions.
Binary file modified source/docs/usage/img/multi-credential-detecting.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions source/docs/usage/misc/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# CLI Usage

The 1Remote also supports CLI commands. This documentation provides an overview of the available CLI commands and their usage.

## Installation and Uninstallation

To install or uninstall the 1Remote tool, use the following commands:

- `--install`: Performs the installation of the 1Remote tool.
- `--uninstall`: Removes the 1Remote tool and its associated files.

## Desktop Shortcut Management

You can manage the desktop shortcut for the 1Remote tool using the following commands:

- `--install-desktop-shortcut`: Installs the desktop shortcut for quick access to the 1Remote tool.
- `--uninstall-desktop-shortcut`: Removes the desktop shortcut.

## Startup Entry Management

The CLI provides commands to manage the registry startup entry for the 1Remote tool:

- `--install-startup`: Sets the 1Remote tool to start automatically on system boot by adding a registry startup entry.
- `--uninstall-startup`: Removes the registry startup entry for the 1Remote tool.

## Running the App Minimized

If you want to run the 1Remote app in a minimized state, use the following command:

- `--start-minimized`: Launches the 1Remote app minimized.

## Executing Connections or Focusing Tags

You can execute specific connections or focus on tags using the following command formats:

- `ULID:<connection-id>`: Runs the 1Remote app and immediately executes and/or focuses on the connection with the specified ID.
- `<connection-name>`: Runs the 1Remote app and immediately executes and/or focuses on the connection with the specified name.
- `#<tag-name>`: Runs the 1Remote app and immediately start the connections associated with the specified tag.

You can also create shortcuts for ULID, connection name, and tags by right-clicking on a connection in the GUI interface.
6 changes: 3 additions & 3 deletions source/docs/usage/misc/help-translation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
It would be really awesome to offer **PRemoteM** in many different languages! So you're really Welcome to translate **PRemoteM** in your (native) language, but don't worry there are just a few strings.
It would be really awesome to offer **1Remote** in many different languages! So you're really Welcome to translate **1Remote** in your (native) language, but don't worry there are just a few strings.

## How to

1. fork and clone
2. open file `glossary.csv` in `Ui\Resources\Languages` by Excel or something.
3. Add a new cloumn for your new language & Fill in the blanks.
4. Run the python script [run_google_translate.bat](https://github.com/1Remote/PRemoteM/blob/dev_net6/Ui/Resources/Languages/run_google_translate.bat), it will analysis the glossary you edited, and fill the blank in it (using Google translate). Then new `.xaml` and `LanguagesList.cs` will be generated.
4. Run the python script `conver_glossary_to_xaml.bat`, it will analysis the glossary you edited, and fill the blank in it (using Google translate). Then new `.xaml` and `LanguagesList.cs` will be generated.

!!! note
- You may have to edit or remove the proxy in the [script](https://github.com/1Remote/1Remote/blob/dev_net6/Ui/Resources/Languages/glossary_maker.py#L142-L144)
- You may have to edit or remove the proxy in `glossary_maker.py`
- Do not edit any `.xaml` / `.cs` files directly, they are auto generated from glossary csv file.

**See all this below were generated, do not edit any of them.**
Expand Down
1 change: 1 addition & 0 deletions source/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ nav:
- Streamline by pre/post connect script:
- Overview: usage/misc/pre-post-script-control/overview.md
- Pre-open a VPN: usage/misc/pre-post-script-control/open-a-vpn-before-connect.md
- CLI: usage/misc/cli.md
- Note for servers: usage/misc/note-for-servers.md
- Help translation: usage/misc/help-translation.md
# - Customized: usage/misc/customized.md
Expand Down

0 comments on commit 19470e1

Please sign in to comment.