Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
p0dalirius authored Dec 18, 2024
1 parent 777e9d2 commit 1139185
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,27 @@

## Install

To install `smbclient-ng`, you can use pip. Run the following command in your terminal:
To install `smbclient-ng`, you can use `pip`, `pip3` or `pipx`. You can run any of the following command in your terminal to install [smbclient-ng](https://github.com/p0dalirius/smbclient-ng) :

```
python3 -m pip install smbclientng
pipx install smbclientng
```
+ With `pip`:
```
python3 -m pip install smbclientng
```
+ With `pip3`:
```
pip3 install smbclientng
```
+ With `pipx`:
```
pipx install smbclientng
```
## Demonstration
![](./.github/example.png)

## Usage
```
Expand Down Expand Up @@ -114,14 +123,13 @@ Authentication & connection:
--aes-key hex key AES key to use for Kerberos Authentication (128 or 256 bits).
-k, --kerberos Use Kerberos authentication. Grabs credentials from .ccache file (KRB5CCNAME) based on target parameters. If
valid credentials cannot be found, it will use the ones specified in the command line.
```
## Quick win commands
## Quick start commands
+ Connect to a remote SMB server:
```
./smbclient-ng.py -d "LAB" -u "Administrator" -p 'Admin123!' --host "10.0.0.201"
smbclient-ng -d "LAB" -u "Administrator" -p 'Admin123!' --host "10.0.0.201"
```
## Contributing
Expand Down

0 comments on commit 1139185

Please sign in to comment.