summaryrefslogtreecommitdiff
path: root/src/frontend/cli/sisyphus-cli.py
blob: 28c9216d7e38ecf0555492fa5507b1c8f5838ccc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
#!/usr/bin/python3

import sisyphus
import typer
from typing import List
from enum import Enum

sisyphus.check.update()
sisyphus.setjobs.start.__wrapped__() # undecorate

app = typer.Typer()
mirrorSetup = typer.Typer()
app.add_typer(mirrorSetup, name="mirror", help='List/Set the active binary repository mirror.')

@app.callback()
def app_callback(ctx: typer.Context):
    """Sisyphus is a simple python wrapper around portage, gentoolkit, and portage-utils
    which provides an apt-get/yum-alike interface to these commands,
    to assist newcomer people transitioning from Debian/RedHat-based systems to Gentoo.

    Use 'sisyphus COMMAND --help' for detailed usage.
    """
    ctx.info_name = 'sisyphus'

@app.command("search")
def search(pkgname: List[str]):
    """Search for binary and/or ebuild (source) packages."""
    sisyphus.search.start(pkgname)

@app.command("install")
def install(pkgname: List[str], hybrid: bool = typer.Option(False, "--hybrid", "-h")):
    """Install binary and/or ebuild(source) packages.
    By default, only binary packages will be installed.
    Use the --hybrid option to install ebuild(source) packages.

    * Examples:

    'sisyphus install pidgin'

    will install pidgin binary package (if available); if there is none, but the ebuild(source) package for pidgin is found, it will stop and suggest the --hybrid option.

    'sisyphus install pidgin --hybrid'

    will compile pidgin from source

    The --hybrid option will preffer to reuse binary packages(if available) to satisfy the dependencies for the ebuild(source) package, speeding up the installation.
    You can use the --hybrid option even if you don't want to install any ebuild(source) packages; It will fall back to binary packages only.
    """
    if not hybrid:
        sisyphus.install.start(pkgname)
    else:
        sisyphus.installhybrid.start(pkgname)

@app.command("uninstall")
def uninstall(pkgname: List[str], force: bool = typer.Option(False, "--force", "-f")):
    """Uninstall packages *SAFELY* by checking for reverse dependencies.
    If reverse dependencies exist, the package(s) will NOT be uninstalled to prevent the possible breakage of the system.
    If you really want to uninstall the package, make sure you uninstall all reverse dependencies as well.
    This will not allways be possible, as the reverse dependency chain may be way to long and require you to uninstall critical system packages.

    * Examples:

    'sisyphus uninstall firefox'

    will succeed, nothing depends on it

    'sisyphus uninstall pulseaudio'

    will fail, many packages depend on it

    With --force option, packages are uninstalled *UNSAFELY* by ignoring reverse dependencies.
    This may break your system if you uninstall critical packages.
    It will try the best it can to preserve the libraries required by other packages to prevent such a breakage.
    Upgrading the system may pull the packages back in, to fix the reverse dependency chain.

    * Examples :

    'sisyphus uninstall pulseaudio --force'

    will succeed, but you may no longer have audio

    'sisyphus uninstall openrc --force'

    will succeed, but the system will be broken
    """
    if not force:
        sisyphus.uninstall.start(pkgname)
    else:
        sisyphus.uninstallforce.start(pkgname)

@app.command("autoremove")
def autoremove():
    """Uninstall packages that are no longer needed.
    When you uninstall a package without it's reverse dependencies, those dependencies will become orphans if nothing else requires them.
    In addition, a package may no longer depend on another one, so that other package becomes orphan as well if nothing else requires it.
    Use this option to check the whole dependency chain for such packages, and uninstall them.
    """
    sisyphus.autoremove.start()

@app.command("update")
def update():
    """Update the Portage tree, the Redcore Overlay(s), Portage configs and Sisyphus's package database."""
    sisyphus.update.start()

@app.command("upgrade")
def upgrade(hybrid: bool = typer.Option(False, "--hybrid", "-h")):
    """Upgrade the system using binary and/or ebuild (source) packages.
    By default, only binary packages will be upgraded.
    However, if you installed any ebuild(source) packages with the '--hybrid' option, it would make sense to upgrade them too.
    Use the --hybrid option to upgrade **EVERYTHING**, binary and/or ebuild(source) packages.

    * Examples:

    'sisyphus upgrade'

    will upgrade the system using binary packages; if any ebuild(source) package upgrade is detected, it will stop and suggest the --hybrid option

    'sisyphus upgrade --hybrid'

    will upgrade the system using both binary and/or ebuild(source) packages

    The --hybrid option will preffer to reuse binary packages(if available) to satisfy the dependencies for the ebuild(source) packages, speeding up the upgrade.
    You can use the --hybrid option even if you don't have any ebuild(source) packages installed; It will fall back to binary packages only.
    """
    if not hybrid:
        sisyphus.upgrade.start()
    else:
        sisyphus.upgradehybrid.start()

@app.command("spmsync")
def spmsync():
    """Sync Sisyphus's package database with Portage's package database.
    When you install something with Portage directly (emerge), Sisyphus is not aware of that package, and it doesn't track it in it's database.
    Use this command to synchronize Sisyphus's package database with Portage's package database.
    """
    sisyphus.spmsync.start()

@app.command("rescue")
def rescue():
    """Resurrect Sisyphus's package database if lost or corrupted.
    If for some reason Sisyphus's package database is lost or corrupted, it can be resurrected using Portage's package database.
    If Portage's package database is corrupted (in this case you're screwed anyway :D), only a partial resurrection will be possible.
    If Portage's package database is intact, full resurrection will be possible.
    """
    sisyphus.rescue.start()

class Branch(str, Enum):
    master = 'master'
    next = 'next'

class Remote(str, Enum):
    gitlab = 'gitlab'
    pagure = 'pagure'

@app.command("branch")
def branch(branch: Branch = typer.Argument(...), remote: Remote = typer.Option(Remote.pagure, "--remote", "-r")):
    """Pull the selected branch of the Portage tree, Redcore overlay and Portage configs.
    The remote can be selected by using the --remote option.

    'BRANCH' can be one of the following : master, next

    'REMOTE' can be one of the following : gitlab, pagure (default is pagure)

    * Examples:

    'branch master --remote=gitlab' will pull the branch 'master' from gitlab.com

    'branch next --remote=pagure' will pull the branch 'next' from pagure.io

    !!! WARNING !!!

    Once you changed the branch, you must pair it with the correct binary repository.

    Branch 'master' must be paired with the stable binary repository (odd numbers in 'sisyphus mirror list').

    * Examples : 'sisyphus mirror set 1' or 'sisyphus mirror set 5'

    Branch 'next' must be paired with the testing binary repository (even numbers in 'sisyphus mirror list').

    * Examples : 'sisyphus mirror set 2' or 'sisyphus mirror set 8'
    """
    sisyphus.branchsetup.start(branch.value, remote.value)

@app.command("sysinfo")
def sysinfo():
    """Display information about installed core packages and portage configuration."""
    sisyphus.sysinfo.show()

@mirrorSetup.command("list")
def mirrorlist():
    """List available binary package repository mirrors (the active one is marked with *)."""
    sisyphus.mirror.printList()

@mirrorSetup.command("set")
def mirrorset(index: int):
    """Change the binary package repository to the selected mirror."""
    sisyphus.mirror.setActive(index)

if __name__ == "__main__":
    app()