Metadata-Version: 2.5
Name: dflash-console
Version: 0.3.105
Summary: Local control panel and terminal CLI for DFlash stacks and local model runtimes
Project-URL: Homepage, https://github.com/ilan4ever/Dflash-Console
Project-URL: Repository, https://github.com/ilan4ever/Dflash-Console
Project-URL: Issues, https://github.com/ilan4ever/Dflash-Console/issues
Author: ILAN AVIV
License: GNU AFFERO GENERAL PUBLIC LICENSE
        Version 3, 19 November 2007
        
        Copyright (C) 2007 Free Software Foundation, Inc.
        Everyone is permitted to copy and distribute verbatim copies
        of this license document, but changing it is not allowed.
        
        Preamble
        
        The GNU Affero General Public License is a free, copyleft license for
        software and other kinds of works, specifically designed to ensure
        cooperation with the community in the case of network server software.
        
        The licenses for most software and other practical works are designed
        to take away your freedom to share and change the works. By contrast,
        our General Public Licenses are intended to guarantee your freedom to
        share and change all versions of a program--to make sure it remains free
        software for all its users.
        
        When we speak of free software, we are referring to freedom, not
        price. Our General Public Licenses are designed to make sure that you
        have the freedom to distribute copies of free software (and charge for
        them if you wish), that you receive source code or can get it if you
        want it, that you can change the software or use pieces of it in new
        free programs, and that you know you can do these things.
        
        Developers that use our General Public Licenses protect your rights
        with two steps: (1) assert copyright on the software, and (2) offer
        you this License which gives you legal permission to copy, distribute
        and/or modify the software.
        
        A secondary benefit of defending all users' freedom is that
        improvements made in alternate versions of the program, if they
        receive widespread use, become available for other developers to
        incorporate. Many developers of free software are heartened and
        encouraged by the resulting cooperation. However, in the case of
        software used on network servers, this result may fail to come about.
        The GNU General Public License permits making a modified version and
        letting the public access it on a server without ever releasing its
        source code to the public.
        
        The GNU Affero General Public License is designed specifically to
        ensure that, in such cases, the modified source code becomes available
        to the community. It requires the operator of a network server to
        provide the source code of the modified version running there to the
        users of that server. Therefore, public use of a modified version, on
        a publicly accessible server, gives the public access to the source
        code of the modified version.
        
        An older license, called the Affero General Public License and
        published by Affero, was designed to accomplish similar goals. This is
        a different license, not a version of the Affero GPL, but Affero has
        released a new version of the Affero GPL which permits relicensing under
        this license.
        
        The precise terms and conditions for copying, distribution and
        modification follow.
        
        TERMS AND CONDITIONS
        
        0. Definitions.
        
        "This License" refers to version 3 of the GNU Affero General Public License.
        
        "Copyright" also means copyright-like laws that apply to other kinds of
        works, such as semiconductor masks.
        
        "The Program" refers to any copyrightable work licensed under this
        License. Each licensee is addressed as "you". "Licensees" and
        "recipients" may be individuals or organizations.
        
        To "modify" a work means to copy from or adapt all or part of the work
        in a fashion requiring copyright permission, other than the making of an
        exact copy. The resulting work is called a "modified version" of the
        earlier work or a work "based on" the earlier work.
        
        A "covered work" means either the unmodified Program or a work based
        on the Program.
        
        To "propagate" a work means to do anything with it that, without
        permission, would make you directly or secondarily liable for
        infringement under applicable copyright law, except executing it on a
        computer or modifying a private copy. Propagation includes copying,
        distribution (with or without modification), making available to the
        public, and in some countries other activities as well.
        
        To "convey" a work means any kind of propagation that enables other
        parties to make or receive copies. Mere interaction with a user through
        a computer network, with no transfer of a copy, is not conveying.
        
        An interactive user interface displays "Appropriate Legal Notices"
        to the extent that it includes a convenient and prominently visible
        feature that (1) displays an appropriate copyright notice, and (2)
        tells the user that there is no warranty for the work (except to the
        extent that warranties are provided), that licensees may convey the
        work under this License, and how to view a copy of this License. If
        the interface presents a list of user commands or options, such as a
        menu, a prominent item in the list meets this criterion.
        
        1. Source Code.
        
        The "source code" for a work means the preferred form of the work
        for making modifications to it. "Object code" means any non-source
        form of a work.
        
        A "Standard Interface" means an interface that either is an official
        standard defined by a recognized standards body, or, in the case of
        interfaces specified for a particular programming language, one that
        is widely used among developers working in that language.
        
        The "System Libraries" of an executable work include anything,
        other than the work as a whole, that (a) is included in the normal
        form of packaging a Major Component, but which is not part of that
        Major Component, and (b) serves only to enable use of that Major
        Component, or to implement a Standard Interface for which an
        implementation is available to the public in source code form. A
        "Major Component", in this context, means a major essential component
        (kernel, window system, and so on) of the specific operating system
        (if any) on which the executable work runs, or a compiler used to
        produce the work, or an object code interpreter used to run it.
        
        The "Corresponding Source" for a work in object code form means all
        the source code needed to generate, install, and (for an executable
        work) run the object code and to modify the work, including scripts to
        control those activities. However, it does not include the work's
        System Libraries, or general-purpose tools or generally available free
        programs which are used unmodified in performing those activities but
        which are not part of the work. For example, Corresponding Source
        includes interface definition files associated with source files for
        the work, and the source code for shared libraries and dynamically
        linked subprograms that the work is specifically designed to require,
        such as by intimate data communication or control flow between those
        subprograms and other parts of the work.
        
        The Corresponding Source need not include anything that users
        can regenerate automatically from other parts of the Corresponding
        Source.
        
        The Corresponding Source for a work in source code form is that
        same work.
        
        2. Basic Permissions.
        
        All rights granted under this License are granted for the term of
        copyright on the Program, and are irrevocable provided the stated
        conditions are met. This License explicitly affirms your unlimited
        permission to run the unmodified Program. The output from running a
        covered work is covered by this License only if the output, given its
        content, constitutes a covered work. This License acknowledges your
        rights of fair use or other equivalent, as provided by copyright law.
        
        You may make, run and propagate covered works that you do not
        convey, without conditions so long as your license otherwise remains
        in force. You may convey covered works to others for the sole purpose
        of having them make modifications exclusively for you, or provide you
        with facilities for running those works, provided that you comply with
        the terms of this License in conveying all material for which you do
        not control copyright. Those thus making or running the covered works
        for you must do so exclusively on your behalf, under your direction
        and control, on terms that prohibit them from making any copies of
        your copyrighted material outside their relationship with you.
        
        Conveying under any other circumstances is permitted solely under
        the conditions stated below. Sublicensing is not allowed; section 10
        makes it unnecessary.
        
        3. Protecting Users' Legal Rights From Anti-Circumvention Law.
        
        No covered work shall be deemed part of an effective technological
        measure under any applicable law fulfilling obligations under article
        11 of the WIPO copyright treaty adopted on 20 December 1996, or
        similar laws prohibiting or restricting circumvention of such
        measures.
        
        When you convey a covered work, you waive any legal power to forbid
        circumvention of technological measures to the extent such
        circumvention is effected by exercising rights under this License
        with respect to the covered work, and you disclaim any intention to
        limit operation or modification of the work as a means of enforcing,
        against the work's users, your or third parties' legal rights to
        forbid circumvention of technological measures.
        
        4. Conveying Verbatim Copies.
        
        You may convey verbatim copies of the Program's source code as you
        receive it, in any medium, provided that you conspicuously and
        appropriately publish on each copy an appropriate copyright notice;
        keep intact all notices stating that this License and any
        non-permissive terms added in accord with section 7 apply to the code;
        keep intact all notices of the absence of any warranty; and give all
        recipients a copy of this License along with the Program.
        
        You may charge any price or no price for each copy that you convey,
        and you may offer support or warranty protection for a fee.
        
        5. Conveying Modified Source Versions.
        
        You may convey a work based on the Program, or the modifications to
        produce it from the Program, in the form of source code under the
        terms of section 4, provided that you also meet all of these conditions:
        
        a) The work must carry prominent notices stating that you modified
        it, and giving a relevant date.
        
        b) The work must carry prominent notices stating that it is released
        under this License and any conditions added under section 7. This
        requirement modifies the requirement in section 4 to "keep intact all
        notices".
        
        c) You must license the entire work, as a whole, under this License
        to anyone who comes into possession of a copy. This License will
        therefore apply, along with any applicable section 7 additional
        terms, to the whole of the work, and all its parts, regardless of
        how they are packaged. This License gives no permission to license
        the work in any other way, but it does not invalidate such permission
        if you have separately received it.
        
        d) If the work has interactive user interfaces, each must display
        Appropriate Legal Notices; however, if the Program has interactive
        interfaces that do not display Appropriate Legal Notices, your work
        need not make them do so.
        
        A compilation of a covered work with other separate and independent
        works, which are not by their nature extensions of the covered work,
        and which are not combined with it such as to form a larger program,
        in or on a volume of a storage or distribution medium, is called an
        "aggregate" if the compilation and its resulting copyright are not
        used to limit the access or legal rights of the compilation's users
        beyond what the individual works permit. Inclusion of a covered work
        in an aggregate does not cause this License to apply to the other
        parts of the aggregate.
        
        6. Conveying Non-Source Forms.
        
        You may convey a covered work in object code form under the terms of
        sections 4 and 5, provided that you also convey the machine-readable
        Corresponding Source under the terms of this License, in one of these
        ways:
        
        a) Convey the object code in, or embodied in, a physical product
        (including a physical distribution medium), accompanied by the
        Corresponding Source fixed on a durable physical medium customarily
        used for software interchange.
        
        b) Convey the object code in, or embodied in, a physical product
        (including a physical distribution medium), accompanied by a written
        offer, valid for at least three years and valid for as long as you
        offer spare parts or customer support for that product model, to give
        anyone who possesses the object code either (1) a copy of the
        Corresponding Source for all the software in the product that is
        covered by this License, on a durable physical medium customarily
        used for software interchange, for a price no more than your
        reasonable cost of physically performing this conveying of source, or
        (2) access to copy the Corresponding Source from a network server at
        no charge.
        
        c) Convey individual copies of the object code with a copy of the
        written offer to provide the Corresponding Source. This alternative
        is allowed only occasionally and noncommercially, and only if you
        received the object code with such an offer, in accord with subsection
        6b.
        
        d) Convey the object code by offering access from a designated place
        (gratis or for a charge), and offer equivalent access to the
        Corresponding Source in the same way through the same place at no
        further charge. You need not require recipients to copy the
        Corresponding Source along with the object code. If the place to copy
        the object code is a network server, the Corresponding Source may be
        on a different server (operated by you or a third party) that supports
        equivalent copying facilities, provided you maintain clear directions
        next to the object code saying where to find the Corresponding Source.
        Regardless of what server hosts the Corresponding Source, you remain
        obligated to ensure that it is available for as long as needed to
        satisfy these requirements.
        
        e) Convey the object code using peer-to-peer transmission, provided
        you inform other peers where the object code and Corresponding Source
        of the work are being offered to the general public at no charge
        under subsection 6d.
        
        A separable portion of the object code, whose source code is excluded
        from the Corresponding Source as a System Library, need not be
        included in conveying the object code work.
        
        A "User Product" is either (1) a "consumer product", which means a
        tangible personal property which is normally used for personal,
        family, or household purposes, or (2) anything designed or sold for
        incorporation into a dwelling. In determining whether a product is a
        consumer product, doubtful cases shall be resolved in favor of
        coverage. For a particular product received by a particular user,
        "normally used" refers to a typical or common use of that class of
        product, regardless of the status of the particular user or of the
        way in which the particular user actually uses, or expects or is
        expected to use, the product. A product is a consumer product
        regardless of whether the product has substantial commercial,
        industrial or non-consumer uses, unless such uses represent the only
        significant mode of use of the product.
        
        "Installation Information" for a User Product means any methods,
        procedures, authorization keys, or other information required to
        install and execute modified versions of a covered work in that User
        Product from a modified version of its Corresponding Source. The
        information must suffice to ensure that the continued functioning of
        the modified object code is in no case prevented or interfered with
        solely because modification has been made.
        
        If you convey an object code work under this section in, or with, or
        specifically for use in, a User Product, and the conveying occurs as
        part of a transaction in which the right of possession and use of the
        User Product is transferred to the recipient in perpetuity or for a
        fixed term (regardless of how the transaction is characterized), the
        Corresponding Source conveyed under this section must be accompanied
        by the Installation Information. But this requirement does not apply
        if neither you nor any third party retains the ability to install
        modified object code on the User Product (for example, the work has
        been installed in ROM).
        
        The requirement to provide Installation Information does not include
        a requirement to continue to provide support service, warranty, or updates
        for a work that has been modified or installed by the recipient, or for
        the User Product in which it has been modified or installed. Access to a
        network may be denied when the modification itself materially and adversely
        affects the operation of the network or violates the rules and protocols for
        communication across the network.
        
        Corresponding Source conveyed, and Installation Information provided,
        in accord with this section must be in a format that is publicly
        documented (and with an implementation available to the public in
        source code form), and must require no special password or key for
        unpacking, reading or copying.
        
        7. Additional Terms.
        
        "Additional permissions" are terms that supplement the terms of this
        License by making exceptions from one or more of its conditions.
        Additional permissions that are applicable to the entire Program shall
        be treated as though they were included in this License, to the extent
        that they are valid under applicable law. If additional permissions
        apply only to part of the Program, that part may be used separately
        under those permissions, but the entire Program remains governed by
        this License without regard to the additional permissions.
        
        When you convey a copy of a covered work, you may at your option
        remove any additional permissions from that copy, or from any part of
        it. (Additional permissions may be written to require their own
        removal in certain cases when you modify the work.) You may place
        additional permissions on material, added by you to a covered work,
        for which you have or can give appropriate copyright permission.
        
        Notwithstanding any other provision of this License, for material you
        add to a covered work, you may (if authorized by the copyright holders
        of that material) supplement the terms of this License with terms:
        
        a) Disclaiming warranty or limiting liability differently from the
        terms of sections 15 and 16 of this License; or
        
        b) Requiring preservation of specified reasonable legal notices or
        author attributions in that material or in the Appropriate Legal
        Notices displayed by works containing it; or
        
        c) Prohibiting misrepresentation of the origin of that material, or
        requiring that modified versions of such material be marked in
        reasonable ways as different from the original version; or
        
        d) Limiting the use for publicity purposes of names of licensors or
        authors of the material; or
        
        e) Declining to grant rights under trademark law for use of some
        trade names, trademarks, or service marks; or
        
        f) Requiring indemnification of licensors and authors of that material
        by anyone who conveys the material (or modified versions of it) with
        contractual assumptions of liability to the recipient.
        
        All other non-permissive additional terms are considered "further
        restrictions" within the meaning of section 10. If the Program as you
        received it, or any part of it, contains a notice stating that it is
        governed by this License along with a term that is a further
        restriction, you may remove that term. If a license document contains
        a further restriction but permits relicensing or conveying under this
        License, you may add to a covered work material governed by the terms
        of that license document, provided that the further restriction does
        not survive such relicensing or conveying.
        
        If you add terms to a covered work in accord with this section, you
        must place, in the relevant source files, a statement of the additional
        terms that apply to those files, or a notice indicating where to find
        the applicable terms.
        
        Additional terms, permissive or non-permissive, may be stated in the
        form of a separately written license, or stated as exceptions; the
        above requirements apply either way.
        
        8. Termination.
        
        You may not propagate or modify a covered work except as expressly
        provided under this License. Any attempt otherwise to propagate or
        modify it is void, and will automatically terminate your rights under
        this License (including any patent licenses granted under the third
        paragraph of section 11).
        
        However, if you cease all violation of this License, then your license
        from a particular copyright holder is reinstated (a) provisionally,
        unless and until the copyright holder explicitly and finally
        terminates your license, and (b) permanently, if the copyright holder
        fails to notify you of the violation by some reasonable means prior to
        60 days after the cessation.
        
        Moreover, your license from a particular copyright holder is reinstated
        permanently if the copyright holder notifies you of the violation by
        some reasonable means, this is the first time you have received notice
        of a violation of this License (for any work) from that copyright
        holder, and you cure the violation prior to 30 days after your receipt
        of the notice.
        
        Termination of your rights under this section does not terminate the
        licenses of parties who have received copies or rights from you under
        this License. If your rights have been terminated and not permanently
        reinstated, you do not qualify to receive new licenses for the same
        material under section 10.
        
        9. Acceptance Not Required for Having Copies.
        
        You are not required to accept this License in order to receive or run
        a copy of the Program. Ancillary propagation of a covered work
        occurring solely as a consequence of using peer-to-peer transmission
        to receive a copy likewise does not require acceptance. However,
        nothing other than this License grants you permission to propagate or
        modify any covered work. These actions infringe copyright if you do
        not accept this License. Therefore, by modifying or propagating a
        covered work, you indicate your acceptance of this License to do so.
        
        10. Automatic Licensing of Downstream Recipients.
        
        Each time you convey a covered work, the recipient automatically
        receives a license from the original licensors, to run, modify and
        propagate that work, subject to this License. You are not responsible
        for enforcing compliance by third parties with this License.
        
        An "entity transaction" is a transaction transferring control of an
        organization, or substantially all assets of one, or subdividing an
        organization, or merging organizations. If propagation of a covered
        work results from an entity transaction, each party to that transaction
        who receives a copy of the work also receives whatever licenses to the
        work the party's predecessor in interest had or could give under the
        previous paragraph, plus a right to possession of the Corresponding
        Source of the work from the predecessor in interest, if the
        predecessor has it or can get it with reasonable efforts.
        
        You may not impose any further restrictions on the exercise of the
        rights granted or affirmed under this License. For example, you may
        not impose a license fee, royalty, or other charge for exercise of
        rights granted under this License, and you may not initiate litigation
        (including a cross-claim or counterclaim in a lawsuit) alleging that
        any patent claim is infringed by making, using, selling, offering for
        sale, or importing the Program or any portion of it.
        
        11. Patents.
        
        A "contributor" is a copyright holder who authorizes use under this
        License of the Program or a work on which the Program is based. The
        work thus licensed is called the contributor's "contributor version".
        
        A contributor's "essential patent claims" are all patent claims
        owned or controlled by the contributor, whether already acquired or
        hereafter acquired, that would be infringed by some manner, permitted
        by this License, of making, using, or selling its contributor version,
        but do not include claims that would be infringed only as a consequence
        of further modification of the contributor version. For purposes of
        this definition, "control" includes the right to grant patent
        sublicenses in a manner consistent with the requirements of this
        License.
        
        Each contributor grants you a non-exclusive, worldwide, royalty-free
        patent license under the contributor's essential patent claims, to
        make, use, sell, offer for sale, import and otherwise run, modify and
        propagate the contents of its contributor version.
        
        In the following three paragraphs, a patent license is any express
        agreement or commitment, however denominated, not to enforce a patent
        (such as an express permission to practice a patent or covenant not to
        sue for patent infringement). To "grant" a patent license to a party
        means to make such an agreement or commitment not to enforce a patent
        against the party.
        
        If you convey a covered work, knowingly relying on a patent license,
        and the Corresponding Source of the work is not available for anyone
        to copy, free of charge and under the terms of this License, through a
        publicly available network server or other readily accessible means,
        then you must either (1) cause the Corresponding Source to be so
        available, or (2) arrange to deprive yourself of the benefit of the
        patent license for this particular work, or (3) arrange, in a manner
        consistent with the requirements of this License, to extend the patent
        license to downstream recipients. "Knowingly relying" means you have
        actual knowledge that, but for the patent license, your conveying the
        Program in a country, or your recipient's use of the Program in a
        country, would infringe one or more identifiable patents in that
        country that you have reason to believe are valid.
        
        If, pursuant to or in connection with a single transaction or
        arrangement, you convey, or propagate by procuring conveyance of, a
        covered work, and grant a patent license to some of the parties
        receiving the covered work authorizing them to use, propagate, modify
        or convey a specific copy of the covered work, then the patent license
        you grant is automatically extended to all recipients of the covered
        work and works based on it.
        
        A patent license is "discriminatory" if it does not include within
        the scope of its coverage, prohibits the exercise of, or is conditioned
        on the non-exercise of one or more of the rights that are specifically
        granted under this License. You may not convey a covered work if you
        are a party to an arrangement with a third party that is in the
        business of distributing software, under which you make payment to the
        third party based on the extent of your activity of conveying the work,
        and under which the third party grants, to any of the parties who would
        receive the covered work from you, a discriminatory patent license (a)
        in connection with copies of the covered work conveyed by you (or
        copies made from those copies), or (b) primarily for and in connection
        with specific products or compilations that contain the covered work,
        unless you entered into that arrangement, or that patent license was
        granted, prior to 28 March 2007.
        
        Nothing in this License shall be construed as excluding or limiting
        any implied license or other defenses to infringement that may
        otherwise be available to you under applicable patent law.
        
        12. No Surrender of Others' Freedom.
        
        If conditions are imposed on you (whether by court order, agreement or
        otherwise) that contradict the conditions of this License, they do not
        excuse you from the conditions of this License. If you cannot convey a
        covered work so as to satisfy simultaneously your obligations under
        this License and any other pertinent obligations, then as a consequence
        you may not convey it at all. For example, if you agree to terms that
        obligate you to collect a royalty for further conveying from those to
        whom you convey the Program, the only way you could satisfy both
        those terms and this License would be to refrain entirely from
        conveying the Program.
        
        13. Remote Network Interaction; Use with the GNU General Public License.
        
        Notwithstanding any other provision of this License, if you modify the
        Program, your modified version must prominently offer all users
        interacting with it remotely through a computer network (if your
        version supports such interaction) an opportunity to receive the
        Corresponding Source of your version by providing access to the
        Corresponding Source from a network server at no charge, through some
        standard or customary means of facilitating copying of software. This
        Corresponding Source shall include the Corresponding Source for any
        work covered by version 3 of the GNU General Public License that is
        incorporated pursuant to the following paragraph.
        
        Notwithstanding any other provision of this License, you have
        permission to link or combine any covered work with a work licensed
        under version 3 of the GNU General Public License into a single
        combined work. The terms of this License will continue to apply to the
        part which is the covered work, but the work with which it is combined
        will remain governed by version 3 of the GNU General Public License.
        
        14. Revised Versions of this License.
        
        The Free Software Foundation may publish revised and/or new versions
        of the GNU Affero General Public License from time to time. Such new
        versions will be similar in spirit to the present version, but may
        differ in detail to address new problems or concerns.
        
        Each version is given a distinguishing version number. If the Program
        specifies that a certain numbered version of the GNU Affero General
        Public License "or any later version" applies to it, you have the
        option of following the terms and conditions either of that numbered
        version or of any later version published by the Free Software
        Foundation. If the Program does not specify a version number of the
        GNU Affero General Public License, you may choose any version ever
        published by the Free Software Foundation.
        
        If the Program specifies that a proxy can decide which future
        versions of the GNU Affero General Public License can be used, that
        proxy's public statement of acceptance of a version permanently
        authorizes you to choose that version for the Program.
        
        Later license versions may give you additional or different
        permissions. However, no additional obligations are imposed on any
        author or copyright holder as a result of your choosing to follow a
        later license version.
        
        15. Disclaimer of Warranty.
        
        THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
        APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
        HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
        WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
        A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
        PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
        DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
        CORRECTION.
        
        16. Limitation of Liability.
        
        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
        CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
        INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
        ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
        NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
        LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
        OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
        HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
        
        17. Interpretation of Sections 15 and 16.
        
        If the disclaimer of warranty and limitation of liability provided
        above cannot be given local legal effect according to their terms,
        reviewing courts shall apply local law that most closely approximates
        an absolute waiver of all civil liability in connection with the
        Program, unless a warranty or assumption of liability accompanies a
        copy of the Program in return for a fee.
        
        END OF TERMS AND CONDITIONS
        
        How to Apply These Terms to Your New Programs
        
        If you develop a new program, and you want it to be of the greatest
        possible use to the public, the best way to achieve this is to make it
        free software which everyone can redistribute and change under these
        terms.
        
        To do so, attach the following notices to the program. It is safest to
        attach them to the start of each source file to most effectively state
        the exclusion of warranty; and each file should have at least the
        "copyright" line and a pointer to where the full notice is found.
License-File: LICENSE
License-File: NOTICE.md
Keywords: dflash,embeddings,gguf,llama,local-llm
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: fastapi==0.141.1
Requires-Dist: huggingface-hub>=0.23.0
Requires-Dist: pydantic==2.13.4
Requires-Dist: python-multipart==0.0.31
Requires-Dist: uvicorn[standard]==0.52.1
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: httpx==0.28.1; extra == 'dev'
Requires-Dist: pytest==9.1.1; extra == 'dev'
Requires-Dist: twine>=6.0; extra == 'dev'
Description-Content-Type: text/markdown

# DFlash Console

**Local control panel for DFlash speculative-decoding stacks and a unified local model runtime** — manage llama-server engines, Piper TTS, Whisper STT, embeddings, model libraries, Hugging Face downloads, and GPU settings from a single web UI.

> **Status:** Public preview. This project is intended for local, single-user Windows deployments.

**Developer:** ILAN AVIV · **UI:** [http://127.0.0.1:8900/](http://127.0.0.1:8900/) · **Version:** v0.3.105

## Download (Windows)

| Package | Link |
|---------|------|
| **Setup installer** (recommended) | [Latest GitHub Release](https://github.com/ilan4ever/Dflash-Console/releases/latest) — `DFlash-Console-Setup-*-x64.exe` |
| **Portable** | Same Releases page — `DFlash-Console-Portable-*-x64.exe` when published |
| **CLI only** | `pip install dflash-console` then `dflash serve` |

Installed desktop apps check for updates through a separate signed feed (not GitHub).
New installs: use the GitHub Release installer above.

---

## What it does

DFlash Console is a standalone FastAPI + vanilla JavaScript app that sits beside your [DFlash](https://github.com/ilan4ever/Dflash) installation. It gives you an LM Studio–style workbench focused on **your** engine profiles—not a generic chat client.

| Area | Highlights |
|------|------------|
| **Engines** | Start/stop llama-server routers, load & eject models in parallel, live boot progress, token stats on cards, developer logs with clear button |
| **Runtimes** | Unified multi-modal layer: Piper TTS, whisper.cpp STT, embeddings — Console-proxied OpenAI routes, adapter registry, shared ports, process identity |
| **Models** | Full PC library: DFlash, GGUF, Ollama, LM Studio, Piper, Whisper, OCR, and embeddings |
| **Model catalog** | Browse and download Hugging Face models into configured library locations |
| **Settings** | GPU strategy, model storage, engine network/API, MCP client preview, **Locations** panel with config/preset import-export |
| **Documentation** | In-app API reference, user guide, terminal CLI, and release notes |
| **Terminal CLI** | `dflash` command: list, load, chat, embed, delete, nodes, settings, search, pull. Install with `pip install dflash-console` |
| **About** | Developer attribution, version, license, runtime boundary, and public project links |
| **Discovery** | **Scan PC** finds model folders; **Add folder** opens a drive-aware browser (C:, D:, …) |

Router mode uses `--models-preset` with load/unload over HTTP so engines stay listening while models swap.

---

## Multi-modal runtime

DFlash Console is now a **unified local model runtime**, not just a GGUF control
panel. A small **adapter registry** (`core/runtimes/`) lets the Console discover,
load, monitor, and proxy OpenAI-shaped APIs for many model families, while
`llama-server` / DFlash stacks stay the first-class GGUF path.

| Modality | Runtime | Engine | Mode |
|----------|---------|--------|------|
| LLM chat / instruct | `llama-server` | GGUF (existing) | server |
| LLM chat (SafeTensors) | **vLLM** or **Transformers** | Hugging Face folders (`runtimes/vllm/`, `runtimes/transformers/`) | server |
| Embeddings | `llama-server` embedding profile | GGUF (existing) | server |
| Text-to-speech | **Piper** | ONNX voices (`runtimes/piper/`) | CLI |
| Speech-to-text | **whisper.cpp `whisper-server`** | GGUF-whisper (`runtimes/stt/`) | server |
| Vision / OCR | `llama-server` + mmproj | GGUF + projector (existing) | server |

### Runtime bundles (thin installer / fat data root)

Engines and voices live **outside** the Electron installer under the Console
data root:

```
runtimes/
├── piper/                 # piper.exe + espeak-ng-data + voices/*.onnx(+json)
│   └── manifest.json
├── stt/                   # whisper-server.exe + ggml-cuda.dll + ...
│   └── manifest.json
└── process-tokens.json    # shared managed-process identity (read by server.ps1)
```

Each adapter writes a `manifest.json` at boot, exposed read-only at
`GET /api/runtimes/manifests`. Piper and Whisper ship as native bundles.
**vLLM** and **Transformers** download on demand from Settings or the first-run
wizard so the Windows installer stays small.

### Playground modes

The Playground has four modes:

| Mode | What it does |
|------|--------------|
| **Chat** | Chat completions against llama-server / DFlash, or vLLM / Transformers when that engine is loaded |
| **Speak** | Text → Piper WAV (voice picker, speed, download) |
| **Transcribe** | Pick a Whisper model → upload audio → transcript |
| **Embed** | One item per line → vectors; **Export .jsonl** |

### Console-proxied OpenAI routes

Children stay on internal loopback ports; clients only talk to the Console:

| Route | Upstream |
|-------|----------|
| `/api/servers/{id}/v1/chat/completions` | llama-server (existing) |
| `/api/runtimes/piper/v1/audio/speech` | Piper (CLI) |
| `/api/runtimes/stt/v1/audio/transcriptions` | whisper-server (multipart → `/inference`) |
| `/api/servers/{id}/v1/embeddings` | llama-server embedding profile |
| `/api/servers/{id}/embed/batch` | batch embed + `.jsonl` export |

### Console OpenAI gateway (port 8001)

Point any OpenAI-compatible app at one stable base URL —
`http://127.0.0.1:8001/v1` — and the gateway proxies to the loaded engine
(chat, embeddings, TTS, STT). Model names are tolerant (engine id, checkpoint
id, or any alias like `gpt-4o`); chat JIT-loads and streams SSE. Configure in
**Settings → Engine profiles → Console OpenAI gateway**
(`gateway_port`, `gateway_server_id`); see [USER-GUIDE §8](docs/USER-GUIDE.md).

### Process identity & cleanup

Every adapter contributes **path-specific** process-identity tokens
(`runtimes\piper\piper.exe`, `runtimes\stt\whisper-server`) to a shared
registry. `managed_process_identity()`, `server.ps1` stop/shutdown cleanup, and
restart adoption recognise Console-managed children **without** ever adopting
foreign processes (e.g. another app's bundled Piper). Stop/unload kills children
and frees VRAM with no orphans.

### Config

Non-llama runtimes are configured in `config.json` under `runtimes[]`; the
`servers[]` list stays exclusively for llama-server / DFlash / GGUF:

```json
"runtimes": [
  { "id": "tts-main", "runtime_id": "piper", "port": 0, "device_policy": "cpu" },
  { "id": "stt-main", "runtime_id": "stt",  "port": 8910, "device_policy": "gpu" }
]
```

`GET /api/runtimes` merges `servers[]` (synthesised `runtime_id: llama-server`)
with `runtimes[]`. Ports are unique across ui/servers/runtimes (shared
registry); CLI runtimes use `port: 0`.

---

## Recent improvements

### v0.3.104 — pip on PyPI and single-server takeover

| Feature | Description |
|---------|-------------|
| **PyPI** | `pip install dflash-console` is live on [PyPI](https://pypi.org/project/dflash-console/) |
| **dflash serve** | Stops a foreign Console on port 8900 (dev, EXE, or older pip) before starting |
| **Public preview** | GitHub Releases for the Windows installer; Discussions and Issues for feedback |

### v0.3.98 — pip install and extra terminal commands

| Feature | Description |
|---------|-------------|
| **pip package** | `pip install dflash-console` then `dflash serve`. The command is `dflash`. |
| **Terminal** | `dflash embed`, `dflash delete`, `dflash nodes`, and `dflash settings`. |

### v0.3.30 — choose vLLM in the toolbar

| Feature | Description |
|---------|-------------|
| **Engine menu** | Pick vLLM, Transformers, or DFlash on Engines, Playground, and Models before you load. |

### v0.3.29 — vLLM engine

| Feature | Description |
|---------|-------------|
| **vLLM** | Choose vLLM to load Hugging Face models. The engine downloads after install. The first-run wizard can install it on a new PC. |

### v0.3.28 — Windows installer

| Feature | Description |
|---------|-------------|
| **Desktop update** | Production installer with the terminal CLI, full local library list, source filters, and Downloads page. |

### v0.3.27 — full library list and source filters

| Feature | Description |
|---------|-------------|
| **dflash list** | Shows the same full local library as the Models tab. Filter with `--ollama`, `--lmstudio`, `--dflash`, or `--source`. |

### v0.3.26 — dflash works in PowerShell

| Feature | Description |
|---------|-------------|
| **dflash command** | Type `dflash list` in any PowerShell window. The installer registers the command so you do not need `.\dflash`. |

### v0.3.25 — terminal CLI

| Feature | Description |
|---------|-------------|
| **dflash command** | PowerShell can list models, check what is loaded, search, download, and chat with the running Console, the same way `ollama` talks to its server. |

### v0.3.24 — last downloads from this PC

| Feature | Description |
|---------|-------------|
| **Last downloads** | The Downloads page lists models already on this PC and lets you filter the last 24 hours, 7 days, 30 days, 90 days, or 12 months. |

### v0.3.6 — full mobile model names

| Feature | Description |
|---------|-------------|
| **Engine cards** | Narrow views keep the complete model name visible before the compact status details. |

### v0.3.4 — clearer catalog model variants

| Feature | Description |
|---------|-------------|
| **Catalog model cards** | Cards show approximate disk size beneath the update age and identify accelerator checkpoints, GGUF models, and full model weights at a glance. |

### v0.3.3 — higher sidebar restore control

| Feature | Description |
|---------|-------------|
| **Collapsed sidebar arrow** | The restore control is raised while preserving its original colors and appearance. |

### v0.3.2 — responsive engine cards

| Feature | Description |
|---------|-------------|
| **Portrait/split-window layout** | Engine cards switch to compact summaries at narrow browser widths; long names stay on one line while status, memory, token, and unload information remain visible. Desktop card layout is unchanged. |

### v0.3.0-dev — multi-modal runtime

| Feature | Description |
|---------|-------------|
| **Piper TTS** | Native bundle, Playground **Speak**, `POST .../v1/audio/speech`, per-runtime logs |
| **Whisper STT** | whisper.cpp `whisper-server` bundle, Playground **Transcribe**, proxied multipart transcriptions |
| **Embeddings** | Proxied `/v1/embeddings`, batch embed + `.jsonl` export, Playground **Embed** |
| **Runtime registry** | Adapter protocol/registry, `runtimes[]` config, shared port registry, `GET /api/runtimes` |
| **Process identity** | Path-specific tokens; `server.ps1` + supervisor clean up only Console-owned children |
| **Vision polish** | Inspector vision row; image attach gated on model capability |
| **Hardening** | Bundle manifests (`/api/runtimes/manifests`), sandbox/no-shell, per-adapter smoke tests |

### v0.2.9

| Feature | Description |
|---------|-------------|
| **Model catalog** | HF README titles/descriptions, lab filter, size/age on list cards, install detection, card download progress |
| **Download queue** | Global downloads tray, Models tab **Downloading** filter with live progress bars |
| **External API** | `/api/endpoints`, `/api/installed`, `/api/console/logs`, and request logging for integrations |
| **Playground** | Load models from catalog via engine + model picker |
| **UI polish** | Themed dropdowns, settings/docs as main views, terminology cleanup (checkpoint → model) |
| **Portable runtime** | Electron uses an external Console data root so the installer stays small and model files remain local |
| **Production boundary** | Loopback validation, path-safe model/projector handling, release preflight, and public repository security policy |

## Earlier improvements (v0.0.23)

| Feature | Description |
|---------|-------------|
| **Live token stats** | Loaded engine cards show generated tokens and speed; **Generating Xs** updates every second during inference |
| **Parallel loading** | Load multiple engines at once without blocking the UI |
| **Engine card UX** | Click a loaded card to open the runtime inspector; right-click for context menu (details, copy URL, unload, etc.) |
| **Accurate CPU meter** | System bar CPU reading matches Task Manager (process-time delta, not inflated WMI load) |
| **Cleaner load progress** | Solid progress bar without conflicting slide animation |
| **Locations settings** | One panel for config file, DFlash install, logs, presets, and console URL; import/export config and launch presets |
| **Clear engine logs** | One-click clear in the developer log header |
| **Chat proxy fix** | Long completions no longer freeze live stats polling |
| **In-app docs** | Documentation tab with overview, user guide, and full API catalog |

---

## Requirements

- **Windows** (primary target; PowerShell startup scripts)
- **Python 3.10+**
- **PowerShell 7+** (`pwsh`)
- **Node.js 22.12+** (Electron shell and packaging)
- Built **llama-server** and compatible model files in the configured `DFLASH_ROOT`
- NVIDIA GPU optional but recommended for multi-GPU load settings

---

## Quick start

### Install with pip

```powershell
pip install dflash-console
dflash serve
```

Open **http://127.0.0.1:8900/**. The PyPI package is `dflash-console`; the terminal
command is `dflash`. Model weights and `llama-server` stay on this PC
(`DFLASH_ROOT` or Settings). `pip install dflash` is a different project.

### From source

```powershell
git clone https://github.com/ilan4ever/Dflash-Console.git
cd Dflash-Console

# First-time setup
copy config.example.json config.json
# Edit config.json — set dflash_root, server ports, model paths, and enable a server profile.
# Keep model weights, logs, and local credentials out of Git.

.\server.ps1
```

The example server profile is disabled until you point it at a model available
on your machine. This prevents a fresh public checkout from trying to launch
excluded model assets.

Open **http://127.0.0.1:8900/** in your browser.

### Command line (like `ollama`)

The Console is the source of truth for models on this PC. `dflash list` shows
the same full library as the Models tab, including Ollama and LM Studio.

```powershell
pip install dflash-console
dflash serve
dflash help
dflash list
dflash list --ollama
dflash list --lmstudio
dflash list --dflash
dflash list --source library
dflash ps
dflash load qwen
dflash chat "hello"
dflash embed "index this"
dflash delete old-model
dflash nodes
dflash settings
dflash search qwen
```

From a checkout you can also run `.\dflash.ps1 install`.

| Command | What it does |
|---------|----------------|
| `dflash serve` / `open` | Start the UI / open the browser |
| `dflash list` / `ps` / `show` | Library, loaded models, one model |
| `dflash load` / `unload` / `start` / `stop` | Engines |
| `dflash chat` / `embed` | Prompt or vectors |
| `dflash delete` | Remove a local model from disk |
| `dflash nodes` | Other Consoles on your network |
| `dflash settings` | Show or change ports and paths |
| `dflash search` / `pull` / `downloads` | Hugging Face catalog |
| `dflash hardware` / `stats` / `report` / `logs` | This PC |
| `dflash api GET /api/health` | Any Console HTTP route |

Use `dflash <command> --help` for flags. `--json` prints raw server data. The
Console must be running (`dflash serve` or `.\server.ps1`) except for help,
version, serve, and install. Full command list: [docs/CLI.md](docs/CLI.md)
and the public site
[onevoiceai.in/dflash-console/docs](https://onevoiceai.in/dflash-console/docs/CLI.md).

`run.ps1` performs a full developer reset: it releases managed model VRAM,
stops configured engines, and starts a clean Console instance.

Foreground mode (attach logs to the terminal):

```powershell
.\server.ps1 -Foreground
```

Full restart (release GPU + stop engines):

```powershell
.\server.ps1 -Restart
```

Restart API after backend edits:

```powershell
.\scripts\restart-console-server.ps1
```

This is a gentle API restart. It preserves engine listeners, then the new
Console process adopts them and leaves router models unloaded. The UI
auto-refreshes when the API restarts (`/api/health` boot id).

### Desktop app (Electron)

The desktop shell opens the same Console UI in a native window and starts
the local API if it is not already running. The Windows installer is a
desktop shell; the Console data root remains separate so model weights and
llama-server binaries are not copied into every install. Set
`DFLASH_CONSOLE_ROOT` to a checkout containing `server.ps1`, `api`, and
`static`, or choose that folder when the packaged app first starts. The data
root still requires Python 3.10+ and PowerShell 7+.

```powershell
.\scripts\run-electron.ps1
```

Build Windows packages (branded DFlash setup + portable exe):

```powershell
.\scripts\run-electron.ps1 -Build
```

Output lands in `dist-electron/`. The shell uses the configured `ui_port`
(8900 by default) and talks to loopback, so the look and behavior match the
browser. Closing the window leaves the Console API and engines running, same
as closing a browser tab. Windows artifacts are not code-signed by default;
publishers should sign them before distributing outside a trusted team.

---

## Using the app

See **[docs/USER-GUIDE.md](./docs/USER-GUIDE.md)** for a full walkthrough, or open **Documentation → User guide** in the sidebar. The **About** page is available in both the browser UI and the Electron desktop app.

**Typical workflow:**

1. Open **Engines** and turn on an engine profile (toggle or **Load**).
2. Pick a model from the dropdown and click **Load**, or load from the **Models** tab.
3. Watch boot progress and live stats on the card; click the card for runtime settings in the side panel.
4. Point your app at the engine OpenAI URL shown on the card, or use the console proxy at `/api/servers/{id}/v1/chat/completions`.
5. Use the **Playground** mode switcher (**Chat · Speak · Transcribe · Embed**) for TTS, STT, and embedding workflows.
6. Use **Settings → Locations** to back up or restore `config.json` and launch presets.
7. Open **About** for the current release, developer attribution, license, and public project links.

---

## Third-party model libraries and trademarks

DFlash Console can scan model folders that the user explicitly enables, including
local LM Studio libraries. It reads and loads model files already present on the
user's machine; it does not include, copy, or redistribute the LM Studio
application or model weights.

“LM Studio library” identifies the detected folder source only. LM Studio is a
trademark of Element Labs, Inc.; DFlash Console is independent and is not
affiliated with or endorsed by LM Studio. Model files remain subject to the
licenses and terms provided by their respective model authors or distributors.
Users are responsible for checking those terms before copying, publishing, or
commercially deploying model files.

---

## Configuration

| Variable / file | Purpose |
|-----------------|--------|
| `config.json` | Local settings (not committed — copy from `config.example.json`) |
| `models_root` / `./models` | Developer model library inside the Console app folder |
| `DFLASH_ROOT_OVERRIDE` | Optional explicit override for the configured DFlash root |
| `config.json` → `dflash_root` | Path to DFlash repo with llama-server binaries and launch scripts |
| `config.json` → `servers[]` | llama-server / DFlash engine profiles: port, GPU layers, context, idle unload |
| `config.json` → `runtimes[]` | Non-llama runtimes (Piper, STT): `runtime_id`, port, `device_policy` |
| `config.json` → `model_libraries[]` | Folders scanned for local models and HF download targets |

Default UI port is **8900**. Engine ports (e.g. 8090, 8092) are configured per server block.

---

## Security boundary

The Console binds to loopback by default and validates configured engine URLs
as loopback-only. It is designed for one trusted user on one machine; it does
not provide multi-user authentication or CSRF protection. Do not expose the
Console or engine ports to a LAN, reverse proxy, or public network without
adding an authenticated access layer.

Hugging Face downloads use `HF_TOKEN` or `HUGGING_FACE_HUB_TOKEN` when private
repositories require them. Keep those values in the process environment, never
in `config.json` or committed files.

---

## Project layout

```
Dflash-Console/
├── api/app.py              # FastAPI routes
├── core/                   # Config, runtime, model discovery, HF, GPU, inference stats
│   └── runtimes/           # Adapter registry + protocol (piper, stt, noop, contention)
├── runtimes/               # Installed engine bundles (piper/, stt/) + manifests (gitignored)
├── static/                 # UI (HTML, CSS, JS)
├── electron/               # Desktop shell (Electron)
├── scripts/                # Server start / restart / Electron helpers
├── tests/                  # pytest suite
├── dflash_cli/             # `dflash` terminal command
├── pyproject.toml          # pip package `dflash-console`
├── docs/
│   ├── USER-GUIDE.md       # End-user walkthrough
│   ├── CLI.md              # Full terminal command list
│   ├── ARCHITECTURE.md     # Public architecture overview
│   ├── LICENSING.md        # AGPL and redistribution guide
│   ├── RELEASING.md        # GitHub and Windows release process
│   └── ui/                 # UI panel design notes
├── run.ps1                 # Full reset and background API startup
├── package.json            # Electron desktop packaging
├── config.example.json     # Template configuration
├── CONTRIBUTING.md         # Contribution workflow and AGPL terms
├── CODE_OF_CONDUCT.md      # Community standards
├── SUPPORT.md              # Questions, bugs, and contact channels
├── SECURITY.md             # Vulnerability reporting
├── TRADEMARKS.md           # DFlash name and logo policy
├── NOTICE.md               # Copyright and third-party notices
└── LICENSE                 # GNU AGPL v3 or later
```

---

## API (selected)

| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | `/api/health` | Liveness + `boot_id` (UI reload watch) |
| `GET` | `/api/servers` | All engine statuses + inference stats |
| `POST` | `/api/servers/{id}/load` | Load model (optional runtime JSON body) |
| `POST` | `/api/servers/{id}/unload` | Eject model (router stays up) |
| `POST` | `/api/servers/{id}/v1/chat/completions` | Proxy chat; updates live token stats |
| `POST` | `/api/servers/{id}/v1/embeddings` | Text → vectors (embedding profile, OpenAI shape) |
| `POST` | `/api/servers/{id}/embed/batch` | Batch embed text items; optional `.jsonl` export |
| `GET` | `/api/runtimes` | Unified runtime list (`servers[]` + `runtimes[]` + adapters) |
| `GET` | `/api/runtimes/manifests` | Installed runtime plugin manifests + process tokens |
| `POST` | `/api/runtimes/piper/v1/audio/speech` | Text → speech (Piper, OpenAI shape) |
| `POST` | `/api/runtimes/stt/v1/audio/transcriptions` | Audio → text (whisper.cpp, OpenAI shape) |
| `GET` | `/api/models` | Full local library (same as Models tab). `source=ollama\|lmstudio\|dflash\|library` |
| `DELETE` | `/api/models/file` | Delete a local model file or Hugging Face folder |
| `GET` / `POST` / `DELETE` | `/api/nodes` | Remote Console nodes |
| `GET` / `PUT` | `/api/config` | Settings (`dflash settings`) |
| `GET` | `/api/hf/downloads` | Current downloads and last-download history |
| `POST` | `/api/models/load` | Unified loader — load ANY catalog model by path; dispatches by modality |
| `GET` | `/api/gateway` | Console OpenAI gateway status (port, url, running, default server, routes) |
| `GET` | `/api/docs/catalog` | In-app documentation JSON |
| `GET` | `/api/model-libraries/scan` | PC scan for model folders |
| `GET` | `/api/fs/browse` | Folder picker for library paths |
| `GET` | `/api/hf/search` | Hugging Face model search |
| `POST` | `/api/hf/download` | Download GGUF into a library |
| `POST` | `/api/hf/install` | Search → download → load in one call |
| `GET` | `/api/status/loaded` | Currently loaded models (engines + runtimes) |
| `GET` | `/api/status/report` | Full report: CPU/RAM/VRAM, engines, loaded models |
| `DELETE` | `/api/logs/{id}` | Clear engine log file |

Full route list: `api/app.py` or **Documentation** tab in the UI.

---

## Development

```powershell
pip install -e .[dev]
pip install -r requirements-dev.txt
pytest
dflash serve
```

Cursor agents: see `.cursor/rules/dev-server-restart.mdc` — restart the API after Python backend changes.

---

## Related projects

- **DFlash** — speculative decoding stack and llama-server profiles this console manages
- Model weights and native build outputs are intentionally excluded from this repository.

---

## Community and support

Use the repository's public channels so questions and fixes are easy for other
users to find:

- **Questions and setup help:** [GitHub Discussions](https://github.com/ilan4ever/Dflash-Console/discussions)
- **Bug reports:** [Issue tracker](https://github.com/ilan4ever/Dflash-Console/issues/new?template=bug_report.yml)
- **Feature ideas:** [Feature request](https://github.com/ilan4ever/Dflash-Console/issues/new?template=feature_request.yml)
- **Security vulnerabilities:** follow [SECURITY.md](./SECURITY.md) and use
  GitHub's private reporting channel; do not post exploit details publicly.
- **Developer:** [ILAN AVIV](https://github.com/ilan4ever)

Please include the Console version from **About**, Windows and Python versions,
the relevant logs with secrets removed, and a minimal reproduction. Never
include `config.json`, access tokens, model weights, or private logs.

---

## License

This project is licensed under the **GNU Affero General Public License
version 3 or later (AGPL-3.0-or-later)**. See [LICENSE](./LICENSE).

AGPL-covered source may be used, studied, modified, and redistributed under
the license terms. If you distribute a modified version, or run a modified
version as a network service, the AGPL source-sharing obligations apply. The
DFlash name, logo, and other marks are not granted by the software license;
see [TRADEMARKS.md](./TRADEMARKS.md). Third-party runtimes, binaries, model
weights, and other assets remain under their own licenses; see
[NOTICE.md](./NOTICE.md).
The AGPL migration begins with the `0.3.0` release; earlier versions retain
the license that accompanied their distribution.

---

## Credits

DFlash Console is developed and maintained by **ILAN AVIV**. The project is
free software under the GNU AGPL v3 or later. See the [developer profile](https://github.com/ilan4ever),
[source repository](https://github.com/ilan4ever/Dflash-Console), and related
[DFlash project](https://github.com/ilan4ever/Dflash).

When you redistribute or build on DFlash Console, retain the copyright and
license notices and provide the corresponding source as required by the AGPL.
Please also include a link to the
[DFlash Console source repository](https://github.com/ilan4ever/Dflash-Console)
in your README, About page, or other project documentation.

---

## Roadmap

See [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) for the public architecture
overview. Run `python scripts/release-preflight.py` before packaging a
checkout. Public release discussions and roadmap items belong in the
[GitHub issue tracker](https://github.com/ilan4ever/Dflash-Console/issues).
