Configuration

coursemgmt.client.Configuration
See theConfiguration companion class
object Configuration

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final case class CmtCoursesHome(value: File)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CmtGlobalConfigFile(value: File)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CmtHome(value: File)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UserHome(value: File)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def load(): Either[CmtError, Configuration]

loads the configuration, if the configuration is not currently available (for instance, if this is the first time load has run) then the default configuration is created and written to the default location. The default location is $HOME/.cmt but this can be overridden with an environment variable CMT_HOME.

loads the configuration, if the configuration is not currently available (for instance, if this is the first time load has run) then the default configuration is created and written to the default location. The default location is $HOME/.cmt but this can be overridden with an environment variable CMT_HOME.

The global configuration points to a directory where all the installed courses are kept. By default this is located at $HOME/Courses but this can also be overridden with an environment variable CMT_COURSE_HOME

Attributes

Concrete fields

val CmtCoursesHomeEnvKey: String
val CmtGlobalConfigName: String
val CmtHomeEnvKey: String
val CoursesDirectoryToken: String
val CurrentCourseToken: String
val DefaultCmtCoursesHome: String
val UserConfigDir: String