🐚 Python-powered shell. Full-featured and cross-platform.
Find a file
Noorhteen Raja NJ 28590cd4af
Code cleanup (#4260)
* style: reuse _repr_pretty_ function

* fix: remove mutable default args

prevent surprises :)

* refactor: remove unused variable from posix.py

* fix: unbound local variables

* fix: override signature match paren

* fix: revert changes to xonsh.codecache.splitpath

* refactor: remove unused class xonsh.procs.readers.BufferedFDParallelReader

* fix: annotate lazyobj decorator

now completions work in pycharm

* refactor: revert removing BufferedFDParallelReader
2021-05-11 01:46:25 +03:00
.github Please click the 👍 reaction (#4210) 2021-03-31 12:16:23 -04:00
appimage Update pre-requirements.txt (#4073) 2021-01-30 15:13:33 -05:00
ci chore (ci): improve ci workflows and deps management (#3873) 2020-10-19 11:52:37 -04:00
docs docs: Fix image preview for the twitter (#4274) 2021-05-10 09:38:24 -04:00
news Merge pull request #4275 from daniel-shimon/ptk-autopair-with-selection 2021-05-11 01:43:34 +03:00
requirements Fix commands cache testing (#4257) 2021-05-06 09:54:09 -04:00
scripts re-run CI tests 2020-08-08 14:02:44 -04:00
tests feat: Ability to call the program by name from callable alias with the same name without the infinite loop error (#4218) 2021-05-10 09:30:41 -04:00
xonsh Code cleanup (#4260) 2021-05-11 01:46:25 +03:00
xontrib Completion context (#4017) 2021-03-30 13:37:56 -04:00
.authors.yml Update author aliases 2021-03-30 13:48:34 -04:00
.coveragerc Completion context (#4017) 2021-03-30 13:37:56 -04:00
.gitattributes Syntax highlighting for xsh on Github 2020-10-01 23:33:19 +03:00
.gitignore Completion context (#4017) 2021-03-30 13:37:56 -04:00
.mailmap Updated authorship for 0.9.27 2021-03-03 11:29:57 -05:00
.pre-commit-config.yaml chore (ci): improve ci workflows and deps management (#3873) 2020-10-19 11:52:37 -04:00
.travis.yml Add groups to env vars (#4026) 2021-01-04 12:21:44 -05:00
amalgamate.py black updates to tests and docs 2020-08-26 10:10:59 -05:00
AUTHORS.rst Updated authorship for 0.9.27 2021-03-03 11:29:57 -05:00
CHANGELOG.rst fix: RST link typo (#4136) 2021-03-03 13:55:35 -05:00
conftest.py add comment on conftest.py to why it exists 2016-07-17 01:21:11 +02:00
CONTRIBUTING.rst Updated references to point to 'main' instead of 'master' (#4202) 2021-03-30 13:40:43 -04:00
github_deploy_key.enc publish dev and latest release docs on xonsh-docs 2016-10-20 19:48:38 -04:00
license copyright update 2016-06-30 12:24:55 -04:00
logo.txt accomodate pip bug by making setup.py ascii 2015-11-16 15:12:02 -08:00
Makefile Fix ply update directive in Makefile 2018-11-02 14:46:17 -04:00
MANIFEST.in Add all test files to MANIFEST.in 2019-04-07 22:33:01 +02:00
pyproject.toml Cleanup remaining vended ptk bits (#4130) 2021-03-01 16:55:23 -05:00
README.rst Delete codecov.yml (#4232) 2021-04-15 10:16:09 -04:00
release.xsh Fix deprecation warnings from unallowed escapes 2018-10-05 11:51:08 +02:00
rever.xsh Restore test command in rever.xsh 2021-02-04 12:35:30 -05:00
run-tests.xsh Fix commands cache testing (#4257) 2021-05-06 09:54:09 -04:00
scent.py feat: add setting to set custom function to format prompt 2020-10-25 22:49:22 +05:30
setup.cfg Fix commands cache testing (#4257) 2021-05-06 09:54:09 -04:00
setup.py Completion context (#4017) 2021-03-30 13:37:56 -04:00
travis.yml some v3.5 updates 2015-09-13 12:17:11 -04:00
xonsh-in-docker.py Make ptk default version much more recent 2020-09-12 20:01:41 -04:00

xonsh
=====

.. class:: center

    **xonsh** is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.

    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/master/docs/_static/xonsh5.png
            :alt: What is xonsh?
            :align: center

.. class:: center

    If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.

    .. image:: https://badges.gitter.im/xonsh/xonsh.svg
            :target: https://gitter.im/xonsh/xonsh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
            :alt: Join the chat at https://gitter.im/xonsh/xonsh

    .. image:: https://img.shields.io/badge/%23xonsh%3Afeneas.org-Matrix-green
            :target: https://matrix.to/#/#xonsh:feneas.org
            :alt: Matrix room: #xonsh:feneas.org

    .. image:: https://travis-ci.org/xonsh/xonsh.svg?branch=master
            :target: https://travis-ci.org/xonsh/xonsh
            :alt: Travis

    .. image:: https://ci.appveyor.com/api/projects/status/github/xonsh/xonsh?svg=true
            :target: https://ci.appveyor.com/project/xonsh/xonsh
            :alt: Appveyor

    .. image:: https://img.shields.io/badge/Google%20Cloud%20Shell-xonsh-green
            :target: https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/xonsh/xonsh.git
            :alt: Open in Google Cloud Shell

First steps
***********

Visit https://xon.sh for more information:

- `Installation <https://xon.sh/contents.html#installation>`_ - using packages, docker or AppImage.
- `Tutorial <https://xon.sh/tutorial.html>`_ - step by step introduction in xonsh.
- `Xontribs <https://xon.sh/xontribs.html>`_ or `Github Xontribs <https://github.com/topics/xontrib>`_ - list of awesome xonsh extensions.

Projects that use xonsh
***********************

- `gitsome <https://github.com/donnemartin/gitsome>`_: A supercharged Git/shell autocompleter with GitHub integration.
- `rever <https://regro.github.io/rever-docs/>`_: Cross-platform software release tool.
- `Regro autotick bot <https://github.com/regro/cf-scripts>`_: Regro Conda-Forge autoticker.
- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the ssh.

.. _write a tweet: https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/xonsh/xonsh