README.md
changeset 108 cc73f7cb0f21
parent 107 093fc00b333d
child 115 8ae0dda7756d
equal deleted inserted replaced
107:093fc00b333d 108:cc73f7cb0f21
    51 Note that every variable from the configration file can also be set with an environment variable (e.g. `export MADONCTL_INSTANCE='https://mamot.fr'`).
    51 Note that every variable from the configration file can also be set with an environment variable (e.g. `export MADONCTL_INSTANCE='https://mamot.fr'`).
    52 
    52 
    53 ### Usage
    53 ### Usage
    54 
    54 
    55 The complete list of commands is available in the online help (`madonctl help`, `madonctl command --help`...)
    55 The complete list of commands is available in the online help (`madonctl help`, `madonctl command --help`...)
    56 or in the [manpages](https://lilotux.net/~mikael/pub/madonctl/manual/html/).  The [Homepage](https://lilotux.net/~mikael/pub/madonctl/) also contains a plain list of commands.
    56 or in the [manpages](https://lilotux.net/~mikael/pub/madonctl/manual/html/).\
       
    57 The [Homepage](https://lilotux.net/~mikael/pub/madonctl/) also contains a plain list of commands.
    57 
    58 
    58 ### Examples
    59 ### Examples
    59 
    60 
    60 To post a simple "toot":
    61 To post a simple "toot":
    61 ``` sh
    62 ``` sh
    62 % madonctl toot "Hello, World"
    63 % madonctl toot "Hello, World"
    63 ```
    64 ```
    64 
    65 
    65 You can change the toot visibility, add a Content Warning (a.k.a. spoiler) or send a media file:
    66 You can change the toot visibility, add a Content Warning (a.k.a. spoiler)
       
    67 or send a media file:
    66 ``` sh
    68 ``` sh
    67 % madonctl toot --visibility direct "@McKael Hello, you"
    69 % madonctl toot --visibility direct "@McKael Hello, you"
    68 % madonctl toot --visibility private --spoiler CW "The answer was 42"
    70 % madonctl toot --visibility private --spoiler CW "The answer was 42"
    69 % madonctl post --file image.jpg Selfie # Send a media file
    71 % madonctl post --file image.jpg Selfie # Send a media file
    70 ```
    72 ```
   103 % madonctl accounts update --note "Newcomer"      # Update user note (bio)
   105 % madonctl accounts update --note "Newcomer"      # Update user note (bio)
   104 % madonctl accounts update --note ""              # Clear note
   106 % madonctl accounts update --note ""              # Clear note
   105 % madonctl accounts update --avatar me.png        # Update avatar
   107 % madonctl accounts update --avatar me.png        # Update avatar
   106 ```
   108 ```
   107 
   109 
   108 See your own posts:
   110 See your own **posts**:
   109 ``` sh
   111 ``` sh
   110 % madonctl accounts statuses                      # See last posts
   112 % madonctl accounts statuses                      # See last posts
   111 % madonctl accounts statuses --all                # See all statuses
   113 % madonctl accounts statuses --all                # See all statuses
   112 ```
   114 ```
   113 
   115 
   114 Display accounts you're following or your followers:
   116 Display accounts you're **following** or your **followers**:
   115 ``` sh
   117 ``` sh
   116 % madonctl accounts following                     # See last following
   118 % madonctl accounts following                     # See last following
   117 % madonctl accounts following --all               # See all followed accounts
   119 % madonctl accounts following --all               # See all followed accounts
   118 % madonctl accounts followers --limit 30          # Last 30 followers
   120 % madonctl accounts followers --limit 30          # Last 30 followers
   119 ```
   121 ```
   180 
   182 
   181 Please note that madonctl will use one socket per stream, so the number of
   183 Please note that madonctl will use one socket per stream, so the number of
   182 concurrent hashtags is currently limited to 4 for "politeness".
   184 concurrent hashtags is currently limited to 4 for "politeness".
   183 
   185 
   184 
   186 
   185 (Almost) All commands have a **customisable output**:
   187 (Almost) All commands have a **customizable output**:
   186 ``` sh
   188 ``` sh
   187 % madonctl accounts show            # Display an account
   189 % madonctl accounts show            # Display an account
   188 % madonctl accounts show -o yaml    # Display an account, in yaml
   190 % madonctl accounts show -o yaml    # Display an account, in yaml
   189 % madonctl accounts show -o json    # Display an account, in json
   191 % madonctl accounts show -o json    # Display an account, in json
   190 % madonctl stream local -o json     # Stream local timeline and output to JSON
   192 % madonctl stream local -o json     # Stream local timeline and output to JSON