Docs Your repository
Import
Turnkeel has one importer. It reads one source only: a copy of the data folder of the hub that Turnkeel was prototyped in, and writes it into one Turnkeel project. It is not a general importer, and there is no import from other tools yet.
The command
turnkeel import keepfold <dir> --as <handle> [--repo <checkout>] [--dry-run]| Part | Meaning |
|---|---|
<dir> |
A copy of the hub's data folder, with one JSON file per document. It is only read. |
--as <handle> |
The member of the target workspace who becomes the person in the source's records. Required. |
--repo <checkout> |
A checkout of the product's repository, from which the files that review items and posts name are read and uploaded. It is only read. |
--dry-run |
Reads everything, prints the report and writes nothing. |
The workspace and the project come from .turnkeel/turnkeel.yml in the current folder. Both must exist; the importer creates neither and sets no project field.
How it runs
The importer is a command for whoever runs the server. It runs where the server's configuration is, needs no token and does not go through the API, because it writes things no agent may write, such as notes, ticks and asset decisions, with the times its source gives.
- In local mode, stop Turnkeel first: one process opens the data folder at a time, and the importer stops if the folder is in use.
- On Postgres it can run while the server runs, and open pages update.
- A second run adds only what is new. It never changes or deletes a row, so anything edited in Turnkeel after the first run stays.
What it writes
Cards with their status lines, builds with their features, steps, notes, ticks and replies, assets with their decisions and notes, posts, link groups, and receipts as cost lines. Each row's history starts with a line that says it was imported.
- No approval comes across. A post that was approved in the source arrives as needing an OK, so nothing is sent on an approval nobody gave in Turnkeel.
- Agents. Work the source records as done by an agent goes to one imported agent, with no token.
- Gates, listings and the doc list exist only as files in your repository, so for these the importer writes no rows. It writes proposed files into
turnkeel-import/.turnkeel/for you to review, move into the repository and sync.
The report
The importer prints a report and writes it to turnkeel-import/report.md: counts of what it read, wrote and skipped, the parties and the agent it created, posts whose approval was dropped, missing files, and everything it did not import, with counts. Parts of the source with no place in Turnkeel yet, such as ads plans and social analytics, are not imported and are named there. The report holds text from the source and is sent nowhere.
The source of this page will be on GitHub when the repository opens. Something wrong or unclear? Write to us.