Skip to content

Commit

Permalink
doc: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Datalux committed Aug 7, 2020
1 parent 6bf2164 commit 1e17e88
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 32 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![](https://img.shields.io/badge/version-0.5-green)](https://github.com/Datalux/Osintgram/releases/tag/0.5)
[![](https://img.shields.io/badge/version-0.6-green)](https://github.com/Datalux/Osintgram/releases/tag/0.6)
[![](https://img.shields.io/badge/license-GPLv3-blue)](https://img.shields.io/badge/license-GPLv3-blue)


Expand All @@ -24,6 +24,8 @@ Osintgram offers an interactive shell to perform analysis on Instagram account o
- propic Download user's profile picture
- stories Download user's stories
- tagged Get list of users tagged by target
- target Set new target
- wcommented Get a list of user who commented target's photos
```
You can find detailed commands usage [here](commands.md).

Expand All @@ -36,6 +38,7 @@ The tools use Python3.
- v0.3 added features: photos, captions, mediatype, propic
- v0.4 [changelog](https://github.com/Datalux/Osintgram/releases/tag/0.4)
- v0.5 [changelog](https://github.com/Datalux/Osintgram/releases/tag/0.5)
- v0.6 [changelog](https://github.com/Datalux/Osintgram/releases/tag/0.6)

## Tools
<p align="center">
Expand Down
70 changes: 39 additions & 31 deletions commands.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
# Commands list and usage
```
- info Get target info
- addrs Get all registered addressed by target photos
- captions Get user's photos captions
- comments Get total comments of target's posts
- followers Get target followers
- followings Get users followed by target
- hashtags Get hashtags used by target
- info Get target info
- likes Get total likes of target's posts
- comments Get total comments of target's posts
- tagged Get list of users tagged by target
- mediatype Get user's posts type (photo or video)
- photodes Get description of target's photos
- photos Download user's photos in output folder
- captions Get user's photos captions
- mediatype Get user's posts type (photo or video)
- propic Download user's profile picture
- stories Download user's stories
- tagged Get list of users tagged by target
- wcommented Get a list of user who commented target's photos
```

### list (or help)
Show all commands avaible.
### addrs
Return a list with address (GPS) tagged by target in his photos.
The list has post, address and date fields.

### captions
Return a list of all captions used by target in his photos.

### comments
Return the total number of comments in target's posts

### exit
Exit from Osintgram
Expand All @@ -29,12 +37,14 @@ With `FILE=y` you can enable saving in file.

With `FILE=n` you can disable saving in file.

### JSON
Can set preference to export commands output as JSON in output folder. It save output in `<target username>_<command>.JSON` file.
### followers
Return a list with target followers with id, nickname and full name

With `JSON=y` you can enable JSON exporting.
### followings
Return a list with users followed by target with id, nickname and full name

With `JSON=n` you can disable JSON exporting.
### hashtags
Return a list with all hashtag used by target in his photos

### info
Show target info like:
Expand All @@ -47,24 +57,21 @@ Show target info like:
- business catagory (if target has business account)
- is verified?

### addrs
Return a list with address (GPS) tagged by target in his photos.
The list has post, address and date fields.

### followers
Return a list with target followers with id, nickname and full name
### JSON
Can set preference to export commands output as JSON in output folder. It save output in `<target username>_<command>.JSON` file.

### followings
Return a list with users followed by target with id, nickname and full name
With `JSON=y` you can enable JSON exporting.

### hashtags
Return a list with all hashtag used by target in his photos
With `JSON=n` you can disable JSON exporting.

### likes
Return the total number of likes in target's posts

### comments
Return the total number of comments in target's posts
### list (or help)
Show all commands avaible.

### mediatype
Return the number of photos and video shared by target

### photodes
Return a list with the description of the content of target's photos
Expand All @@ -78,16 +85,17 @@ Run a command: photos
How many photos you want to download (default all):
```

### captions
Return a list of all captions used by target in his photos.

### mediatype
Return the number of photos and video shared by target

### propic
Download target profile picture (HD if is avaible)
Download target profile picture (HD if is available)

### stories
Download all target's stories in output folder.

## tagged
Return a list of users tagged by target with ID, username and full name

## wcommented
Return a list of users who commented target's photos sorted by number of comments



0 comments on commit 1e17e88

Please sign in to comment.