Commit 14b04f7e authored by louis-riviere-xyz's avatar louis-riviere-xyz
Browse files

doc

parent 30382b76
# Setux REPL
## Abstract
Rudimentary REPL / CLI for [Setux]
Rudimentary REPL / CLI for Setux
[PyPI] - [Repo] - [Doc]
## Usage
### REPL
$ setux [target]
### CLI
$ setux command [target]
## Installation
$ pip install setux_repl
[PyPI]: https://pypi.org/project/setux_repl
[Repo]: https://framagit.org/louis-riviere-xyz/setux_repl
[Doc]: https://setux-repl.readthedocs.io/en/latest
[Setux]: https://setux.readthedocs.io/en/latest
#!/bin/bash
python3 mkcmds.py
make html
firefox _build/html/index.html
# Commands
## run
run shell cmd on target
## module
show module's help
## modules
list modules
arg = search pattern
## deploy
deploy module
## remote
deploy module remotly
## update
update packages
## upgrade
upgrade packages
May hang, if user input is required.
## installed
list installed packages
## available
list avaiable packages
## bigs
list the bigest installed packages
## upgradable
list upgradble packages
## install
install package
## remove
remove package
## cleanup
cleanup packages
## status
query service status
## start
start service
## stop
stop service
## restart
restart service
## enable
enable service
## disable
disable service
## download
download file
## logs
show log file
arg = level (default to "info")
## outrun
show commands history
## outlog
show commands log
Commands
========
run
---
run shell cmd on target
module
------
show module's help
modules
-------
list modules
arg = search pattern
manager
-------
show manager's help
managers
--------
list managers
arg = search pattern
deploy
------
deploy module
remote
------
deploy module remotly
update
------
update packages
upgrade
-------
upgrade packages
May hang, if user input is required.
installed
---------
list installed packages
installable
-----------
list avaiable packages
search
------
search packages
bigs
----
list the bigest installed packages
upgradable
----------
list upgradble packages
install
-------
install package
remove
------
remove package
cleanup
-------
cleanup packages
status
------
query service status
start
-----
start service
stop
----
stop service
restart
-------
restart service
enable
------
enable service
disable
-------
disable service
download
--------
download file
logs
----
show log file
arg = level (default to "info")
outrun
------
show commands history
outlog
------
show commands log
# Setux Repl
Rudimentary Repl for Setux.
## Requirements
Setux
## Install
see the Setux packags
from setux.repl.helps import helps
with open('cmds.rst', 'w') as out:
def w(txt=''):
out.write(f'{txt}\n')
def t(txt, h='-'):
w(txt)
w(h*len(txt))
w()
t('Commands', '=')
for name, txt in helps.items():
t(f'{name}')
w(f'{txt}')
site_name: Setux-REPL
# Commands
## run
**run shell cmd on target**
## module
**show module's help**
## modules
**list modules**
arg = search pattern
## manager
**show manager's help**
## managers
**list managers**
arg = search pattern
## mappings
**list mappings**
## deploy
**deploy module**
## remote
**deploy module remotly**
## update
**update packages**
## upgrade
**upgrade packages**
May hang, if user input is required.
## installed
**list installed packages**
arg = search pattern
## installable
**list avaiable packages**
arg = search pattern
## search
**search packages**
arg = search pattern
## bigs
**list the bigest installed packages**
## upgradable
**list upgradble packages**
## install
**install package**
## remove
**remove package**
## cleanup
**cleanup packages**
## status
**query service status**
## start
**start service**
## stop
**stop service**
## restart
**restart service**
## enable
**enable service**
## disable
**disable service**
## download
**download file**
## logs
**show log file**
arg = level (default to "info")
## outrun
**show commands history**
## outlog
**show commands log**
## edit
**edit remote file**
arg = file path to edit
# Setux REPL
Rudimentary REPL / CLI for [Setux]
[PyPI] - [Repo] - [Doc]
## Usage
### REPL
```bash
$ setux [target]
```
### CLI
```bash
$ setux command [target]
```
## Installation
```bash
$ pip install setux_repl
```
[PyPI]: https://pypi.org/project/setux_repl
[Repo]: https://framagit.org/louis-riviere-xyz/setux_repl
[Doc]: https://setux-repl.readthedocs.io/en/latest
[Setux]: https://setux.readthedocs.io/en/latest
from setux.repl.helps import helps
with open('docs/cmds.md', 'w') as out:
with open('docs/commands.md', 'w') as out:
def w(txt=''):
out.write(f'{txt}\n')
out.write(f'{txt} \n')
w('# Commands\n')
w(f'# Commands')
for name, txt in helps.items():
w(f'## {name}')
w(f'{txt}')
for n, line in enumerate(txt.split('\n')):
if n==0:
w(f'**{line}**')
else:
w(f'{line}')
site_name: Setux-REPL
nav:
- Overview: README.md
- Commands: commands.md
theme: readthedocs
......@@ -7,9 +7,10 @@ readme = open(join(curdir, 'README.md')).read()
setup(
name = 'setux_repl',
version = '0.21.42.0',
version = '0.21.43.0',
description = 'System deployment',
long_description = readme,
long_description_content_type='text/markdown',
keywords = ['utility', ],
url = 'https://framagit.org/louis-riviere-xyz/setux_repl',
author = 'Louis RIVIERE',
......@@ -30,7 +31,7 @@ setup(
],
python_requires='>3.6',
install_requires = [
'setux>=0.21.42.0',
'setux>=0.21.43.0',
],
packages = find_namespace_packages(
include=['setux.*']
......
......@@ -56,13 +56,13 @@ helps = dict(
download = '''download file
''',
logs = '''show log file
arg = level (default to "info")
arg = level (default to "info")
''',
outrun = '''show commands history
''',
outlog = '''show commands log
''',
edit = '''edit remote file
arg = file path to edit
arg = file path to edit
'''
)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment