The electron-tools Reference Manual

This is the electron-tools Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:21:12 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 electron-tools

Download, extract, and run Electron binaries.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/ceramic/electron-tools

Source Control

(GIT git@github.com:ceramic/electron-tools.git)

Bug Tracker

https://github.com/ceramic/electron-tools/issues

License

MIT

Long Description

# electron-tools

[![Build Status](https://travis-ci.org/ceramic/electron-tools.svg?branch=master)](https://travis-ci.org/ceramic/electron-tools)

A set of tools to download and extract [Electron][electron] binaries.

[electron]: http://electron.atom.io/

# License

Copyright (c) 2015–2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • trivial-download (system).
  • trivial-extract (system).
  • osicat (system).
  • trivial-exe (system).
  • uiop (system).
Source

electron-tools.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 electron-tools/src

Source

electron-tools.asd.

Parent Component

electron-tools (system).

Child Component

electron-tools.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 electron-tools/electron-tools.asd

Source

electron-tools.asd.

Parent Component

electron-tools (system).

ASDF Systems

electron-tools.


4.1.2 electron-tools/src/electron-tools.lisp

Source

electron-tools.asd.

Parent Component

src (module).

Packages

electron-tools.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 electron-tools

Tools for Electron.

Source

electron-tools.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: +download-url+

A format string for the download URL. Values are: version, version, operating system, architecture.

Package

electron-tools.

Source

electron-tools.lisp.


6.1.2 Ordinary functions

Function: app-directory (directory &key operating-system)

The pathname to the application directory of an Electron release.

Package

electron-tools.

Source

electron-tools.lisp.

Function: binary-pathname (directory &key operating-system)

The pathname to the Electron binary inside the directory it was extracted to.

Package

electron-tools.

Source

electron-tools.lisp.

Function: download (pathname &key operating-system version architecture)

Download a release to a pathname.

Package

electron-tools.

Source

electron-tools.lisp.

Function: download-url (&key operating-system version architecture)

A download link to the specified release.

Package

electron-tools.

Source

electron-tools.lisp.

Function: extract (pathname)

Extract an Electron snapshot into its containing directory.

Package

electron-tools.

Source

electron-tools.lisp.

Function: get-release (directory &key operating-system version architecture)

Download an Electron release to the directory.

Package

electron-tools.

Source

electron-tools.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+download-url+: Public special variables

S
Special Variable, +download-url+: Public special variables