Skip to main content

Single Command

Create an entrypoint index.ts file for use with webpack and rollup.js, typedoc

single command option

NameShortDefaultTypeRequiredCommand
--config-cstringsingle
--project-pstringrequiredsingle
--startAt-ause --project valuestringsingle
--exportFilename-findex.tsstringsingle
--useSemicolon-struestringsingle
--useTimestamp-tfalsebooleansingle
--useComment-mtruebooleansingle
--quote-q'stringsingle
--keepFileExt-kfalsebooleansingle
--overwrite-wfalsebooleansingle
--ignoreFile-g.ctiignorestringsingle
--output-ostringrequiredsingle
--useRootDir-rfalsebooleansingle
--noBackupfalsebooleansingle
--spinnerStreamstdoutenum(stdout, stderr)single
--progressStreamstdoutenum(stdout, stderr)single
--reasonerStreamstderrenum(stdout, stderr)single

single command option description

NameDescription
--configconfiguration file(.ctirc) path
--projecttsconfig.json path: you must pass path with filename, like this "./tsconfig.json"
--startAtstart working from startAt directory. If you do not pass startAt use project directory.
--exportFilenameExport filename, if you not pass this field that use "index.ts" or "index.d.ts"
--useSemicolonadd semicolon on line ending at every export statement
--useTimestamptimestamp write on ctix comment right-side, only works in useComment option set true
--useCommentctix comment add on first line of creted export file(default index.ts) file, that remark created from ctix
--quotechange quote character at export syntax
--keepFileExtkeep file extension on export statement path literal
--overwriteoverwrite each index.ts file
--ignoreFileignore file name. You can pass ignore, config file at ctix and use it like profile
--noBackupnot create backup file even if set overwrite option enable
--outputoutput directory
--useRootDiroutput file under rootDir in tsconfig.json.
--spinnerStreamStream of cli spinner, you can pass stdout or stderr
--progressStreamStream of cli progress, you can pass stdout or stderr
--reasonerStreamStream of cli reasoner. Reasoner show name conflict error and already exist index.ts file error. You can pass stdout or stderr