mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 00:14:41 +01:00
Update README.rst
This commit is contained in:
parent
1653faaeee
commit
7c2f0f404b
1 changed files with 54 additions and 8 deletions
62
README.rst
62
README.rst
|
@ -3,19 +3,64 @@ xonsh
|
||||||
|
|
||||||
.. class:: center
|
.. class:: center
|
||||||
|
|
||||||
**xonsh** is a Python-powered shell. Full-featured and cross-platform.
|
**xonsh** is a Python-powered shell. Full-featured and cross-platform. The language is a superset of Python 3.6+ with additional shell primitives. Xonsh pronounced as *conch* (🐚, *@*) and indicates belonging to the command shells world.
|
||||||
|
|
||||||
The language is a superset of Python 3.6+ with additional shell primitives.
|
|
||||||
xonsh (pronounced *conch*) is meant for the daily use of experts and novices alike.
|
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/xonsh/xonsh/main/docs/_static/what_is_xonsh.png
|
.. list-table::
|
||||||
:alt: What is xonsh?
|
:widths: 1 1
|
||||||
:align: center
|
|
||||||
|
* - **Xonsh is the Shell**
|
||||||
|
- **Xonsh is Python**
|
||||||
|
|
||||||
|
* - .. code-block:: shell
|
||||||
|
|
||||||
|
cd $HOME
|
||||||
|
|
||||||
|
id $(whoami)
|
||||||
|
|
||||||
|
cat /etc/passwd | grep root > ~/root.txt
|
||||||
|
|
||||||
|
$PROMPT = '@ '
|
||||||
|
|
||||||
|
|
||||||
|
- .. code-block:: python
|
||||||
|
|
||||||
|
2 + 2
|
||||||
|
|
||||||
|
var = "hello".upper()
|
||||||
|
|
||||||
|
import json; json.loads('{"a":1}')
|
||||||
|
|
||||||
|
[i for i in range(0,10)]
|
||||||
|
|
||||||
|
* - **Xonsh is the Shell in Python**
|
||||||
|
- **Xonsh is Python in the Shell**
|
||||||
|
|
||||||
|
* - .. code-block:: python
|
||||||
|
|
||||||
|
len($(curl -L https://xon.sh))
|
||||||
|
|
||||||
|
$PATH.append('/tmp')
|
||||||
|
|
||||||
|
p'/etc/passwd'.read_text().find('root')
|
||||||
|
|
||||||
|
id = $(@json docker ps --format json)['ID']
|
||||||
|
|
||||||
|
- .. code-block:: python
|
||||||
|
|
||||||
|
name = 'foo' + 'bar'.upper()
|
||||||
|
echo @(name) > /tmp/@(name)
|
||||||
|
|
||||||
|
ls @(input('file: '))
|
||||||
|
|
||||||
|
aliases['e'] = 'echo @(2+2)'
|
||||||
|
aliases['a'] = lambda args: print(args)
|
||||||
|
|
||||||
|
|
||||||
|
If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.
|
||||||
|
|
||||||
.. class:: center
|
.. class:: center
|
||||||
|
|
||||||
If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/Zulip%20Community-xonsh-green
|
.. image:: https://img.shields.io/badge/Zulip%20Community-xonsh-green
|
||||||
:target: https://xonsh.zulipchat.com/join/hbvue5rimpdkwkdjuiqfs7tv/
|
:target: https://xonsh.zulipchat.com/join/hbvue5rimpdkwkdjuiqfs7tv/
|
||||||
:alt: Join to xonsh.zulipchat.com
|
:alt: Join to xonsh.zulipchat.com
|
||||||
|
@ -32,6 +77,7 @@ xonsh
|
||||||
:target: https://repology.org/project/xonsh/versions
|
:target: https://repology.org/project/xonsh/versions
|
||||||
:alt: repology.org
|
:alt: repology.org
|
||||||
|
|
||||||
|
|
||||||
First steps
|
First steps
|
||||||
***********
|
***********
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue