Stack overflow commnand line interface. SoCLI allows you to search and browse stack overfow from the terninal.
Project description
Stack overflow command line stack overflow client written in python. Using SoCLI you can search and browse stack overflow without leaving the terminal. Just use the socli command:
Installation
Supported platforms
Linux
Windows
Mac
Requirements
python 3+ :
For Linux
Install python3 and just use pip command to install socli:
sudo apt-get install python3 python3-pip
sudo pip3 install socli
For Windows
Download and install python 3. Dont forget to check the option “Add to path”.
Open a command prompt with administrative privileges and use pip command to install socli:
pip3 install socli
Use easy_install if your python path have a space in it Read more:”Failed to create process”:
easy_install socli
For Mac (via homebrew)
Install python3 and socli:
brew install python3 python3-pip
pip3 install socli
Updating
Use the command below to update your existing version of socli to the newest version, so that you won’t miss any features:
sudo pip install --upgrade socli
Usage
Quick search
Just use socli command followed by the search query:
socli for loop in python syntax
The above command will search for the query “for loop in python syntax” and displays the first most voted question in stack overflow with its most voted answer. Pretty quick, right?
Interactive search
You can search the stack overflow interactively by using the command below:
socli -iq html error 404
This will display a list of questions from stack overflow for the query “html error 404” and it will allow you to choose any of the question you like interactively. When you chose a question, it will display the complete description of the chosed question with its most voted answer. Now you can browse through all the answers of that questions on stack overflow interactively.
Manual search
This will allow you to choose a question number for example:
socli -r 2 -q javascript porotype function
Will search for “javascript porotype function” in stack overflow and displays the second question that contains it.
New question
If you can’t find an answer for your question in stack overflow, socli allows you to creata a new question via the web browswer. Just type the command below and socli will opwn the web browser for you to post the question:
socli -n
Syntax:
socli has the following syntax
Usage: socli [ Arguments] < Search Query >
Arguments (optional)
Short |
Long |
Descripti on |
Example |
---|---|---|---|
-q |
–query |
Used to specify the query when arguments are used. A query value must be passed to it. If it is used alone (socli -q query) then it will display the same result as “socli query”. |
socli -i -q query |
-i |
–interac tive |
Used to search interacti vely. It doesnt take any values. It must be followed by a -q or –query after it. |
socli -i -q query |
-r |
–res |
Used for manual search. It takes the question number as the argument and it must be followed by a -q or –query after it. |
socli -r 4 -q query |
-n |
–new |
Opens the web browser to create a new question on stack overflow. |
socli –new |
-h |
–help |
Displays the help text. |
socli –help |
Query
It refers to query to search in stack overflow.
Features
These are the amazing features of socli: * Manual Search * Interactively browse stack overflow using the interactive mode * Coloured interface * Question stats view * Can open the page in a browser * Can create a new question via the web browser
Contributing
If you are willing to contribute to SoCLI project, You are awesome! Just follow the steps below:
Fork it!
Make a local clone: sh git clone https://github.com/{YOUR_USERNAME}/socli.git
Switch to the directory: cd socli
Create your new branch: git checkout -b feature name
Make necessary changes to this source code
Add changes to git index by using git add --all .
Commit your changes: git commit -am 'Added new feature'
Push to the branch: git push
Submit a new pull request :smile:
Contributors
Special thanks to these superheroes: * [@Killbee](https://github.com/kilbee) for making SoCLI colorful * Sam Dean for adding Macintosh SoCLI installation instructions * Plinio89s for adding the check for color support
Bugs
If you are experiencing any bugs, don’t forget to open a new issue.
Thanks
Thanks to all the existing users of SoCLI.
Special thanks to people who wrote about SoCLI on their blogs and websites:
Thanks to my fevourite IDE JetBrains PyCharm :heart: :smile:
Liked it?
Hope you liked this project, don’t forget to give it a star :star:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.